From ffaad2d2456bbb77ab02f9a6c88cff27fbc598b6 Mon Sep 17 00:00:00 2001
From: Mattias Ellert <mattias.ellert@physics.uu.se>
Date: Fri, 10 Mar 2023 17:02:43 +0100
Subject: [PATCH] Fix some doxygen warnings

---
 doc/doxygen/features.txt                   | 8 ++++----
 doc/doxygen/mainpage.txt                   | 2 +-
 protobufIO/include/HepMC3/Readerprotobuf.h | 6 +++---
 protobufIO/include/HepMC3/Writerprotobuf.h | 4 ++--
 4 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/doc/doxygen/features.txt b/doc/doxygen/features.txt
index 3f7a82c1..6a1e5ffe 100644
--- a/doc/doxygen/features.txt
+++ b/doc/doxygen/features.txt
@@ -70,11 +70,11 @@
 
 
     ###########################################################################
-    @subsection links Links
+    @subsection links_mem Links
     ###########################################################################
 
     The relations between vertices and particles in GenEventData are encoded via
-     members links1 and links2, wich are std::vector<int> containing object ids.
+    members links1 and links2, wich are std::vector<int> containing object ids.
     Direct manipulations with links1 and links2 can be useful. For instance,
     when the events are saved in ROOT format, one can extract the information
     from links1 and links2 without reading whole event.
@@ -83,13 +83,13 @@
     @code{.cpp}
         // Andrii Verbytskyi, 2017, MPI fuer Physik
         // Here is a code to look for a scattered DIS electron  in HepMC3 event record using links.
-        // The implementation is extended to provide example of links1,lins2 usage.
+        // The implementation is extended to provide example of links1, links2 usage.
         // Dummy code.
         GenEventData*  A=...
         ...
         int i;
         int j;
-        int current_l=0;                             // If the  incoming electron is the first particle in the list
+        int current_l=0;                             // If the incoming electron is the first particle in the list
         int vertex_l=0;                              // We set final vertex to some nonsense value.
         bool found_next_vertex=true;
         while(found_next_vertex)                     // Looking for the electron end vertex
diff --git a/doc/doxygen/mainpage.txt b/doc/doxygen/mainpage.txt
index c200336f..15f535da 100644
--- a/doc/doxygen/mainpage.txt
+++ b/doc/doxygen/mainpage.txt
@@ -19,7 +19,7 @@
      - <a href="https://arxiv.org/pdf/2203.08230.pdf">E.Bothmann et al., A standard convention for particle-level Monte Carlo event-variation weights</a>
     <a href="https://inspirehep.net/literature/2053416"> InSpire record</a>
 
-    - <a href="https://doi.org/10.1016/j.cpc.2006.11.010">J. Alwall et al., A standard format for Les Houches Event Files</a>
+     - <a href="https://doi.org/10.1016/j.cpc.2006.11.010">J. Alwall et al., A standard format for Les Houches Event Files</a>
     <a href="https://inspirehep.net/literature/725284"> InSpire record</a>
 
     @section releases Status of releases
diff --git a/protobufIO/include/HepMC3/Readerprotobuf.h b/protobufIO/include/HepMC3/Readerprotobuf.h
index a893de68..976b3480 100644
--- a/protobufIO/include/HepMC3/Readerprotobuf.h
+++ b/protobufIO/include/HepMC3/Readerprotobuf.h
@@ -145,13 +145,13 @@ private:
 
   /** @brief The file stream of the file being read
    *
-   * @detail This is non-null and owned by this class if constructed with the
+   * @details This is non-null and owned by this class if constructed with the
    * string constructor, otherwise it will be null
    */
   std::unique_ptr<std::ifstream> m_in_file;
   /** @brief The stream object that is read from
    *
-   * @detail If constructed with the string constructor, this just points to
+   * @details If constructed with the string constructor, this just points to
    * m_in_file.get())
    */
   std::istream *m_in_stream = nullptr;
@@ -176,7 +176,7 @@ private:
 
   /** @brief A copy of the library version info stored in the proto file header
    *
-   * @detail This is a copy so as to avoid passing on protobuf header
+   * @details This is a copy so as to avoid passing on protobuf header
    * dependencies to files that include this header
    */
   FileHeader m_file_header;
diff --git a/protobufIO/include/HepMC3/Writerprotobuf.h b/protobufIO/include/HepMC3/Writerprotobuf.h
index 3e23761b..c09b548b 100644
--- a/protobufIO/include/HepMC3/Writerprotobuf.h
+++ b/protobufIO/include/HepMC3/Writerprotobuf.h
@@ -88,13 +88,13 @@ private:
 
   /** @brief The output file stream
    *
-   * @detail This is non-null and owned by this class if the instance was
+   * @details This is non-null and owned by this class if the instance was
    * constructed with the string constructor, it is null otherwise.
    */
   std::unique_ptr<std::ofstream> m_out_file;
   /** @brief The stream object that is written to
    *
-   * @detail If constructed with the string constructor, this just points to
+   * @details If constructed with the string constructor, this just points to
    * m_out_file.get())
    */
   std::ostream *m_out_stream;
-- 
GitLab