Documentation

- Generate tagfile to be used by NumA and PARTONS documentations.
- Some fixed to avoid conflicts with namespaces in documentation.

ElementaryUtils.doxyfile

@@ -780,7 +780,7 @@ WARN_LOGFILE =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT = src include 
+INPUT = src include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1015,7 +1015,7 @@ USE_HTAGS = NO
 # See also: Section \class.
 # The default value is: YES.
 
-VERBATIM_HEADERS = YES
+VERBATIM_HEADERS = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
@@ -2071,7 +2071,7 @@ TAGFILES =
 # tag file that is based on the input files it reads. See section "Linking to
 # external documentation" for more information about the usage of tag files.
 
-GENERATE_TAGFILE = 
+GENERATE_TAGFILE = doc/ElementaryUtilsDoxygen.tag
 
 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
 # the class index. If set to NO, only the inherited external classes will be

doc/.gitignore

+/html/
+/ElementaryUtilsDoxygen.tag

include/ElementaryUtils/PropertiesManager.h

@@ -20,7 +20,7 @@ namespace ElemUtils {
 
 /**
  * @class PropertiesManager
- * @brief \<singleton\> Use for handle properties from configuration's file.
+ * @brief \<singleton\> Handles properties from configuration file.
  */
 class PropertiesManager {
 public:

include/ElementaryUtils/file_utils/FileExceptionType.h

@@ -8,10 +8,6 @@
  * @version 1.0
  *
  * Last update : 15 September 2014
- *
- * @struct FileExceptionType
- *
- * @brief
  */
 
 #include <string>
@@ -19,6 +15,12 @@
 namespace ElemUtils {
 
 //TODO refactoring
+
+/**
+ * @struct FileExceptionType
+ *
+ * @brief
+ */
 struct FileExceptionType {
     //prevent automatic conversion for any other built-in types such as bool, int, etc
     template<typename T>

include/ElementaryUtils/file_utils/FileUtils.h

@@ -7,10 +7,6 @@
  * @version 2.0
  * @date 28/04/2009
  * @date Updated 18/09/2014
- *
- * @class FileUtils
- *
- * @brief Handle file system
  */
 
 #include <fstream> // needed
@@ -23,6 +19,11 @@
 
 namespace ElemUtils {
 
+/*!
+ * @class FileUtils
+ *
+ * @brief Handle file system.
+ */
 class FileUtils {
 public:
 
@@ -30,7 +31,7 @@ public:
 
     /**
      * By default open a file in write mode.
-     * If the file exists its content is deleted.
+     * If the file exists, its content is deleted.
      *
      * @param fileOutputStream
      * @param filePath

include/ElementaryUtils/logger/LoggerClassLevel.h

@@ -6,9 +6,6 @@
  * @author Bryan BERTHOU (SPhN / CEA Saclay)
  * @date 12 September 2014
  * @version 1.0
- *
- * @class LoggerClassLevel
- * @brief
  */
 
 #include <map>
@@ -18,6 +15,11 @@
 
 namespace ElemUtils {
 
+
+/**
+ * @class LoggerClassLevel
+ * @brief
+ */
 class LoggerClassLevel {
 public:
     LoggerClassLevel(const std::string& className,

include/ElementaryUtils/logger/LoggerLevel.h

@@ -6,9 +6,6 @@
  * @author Bryan BERTHOU (SPhN / CEA Saclay)
  * @date 05 September 2014
  * @version 1.0
- *
- * @class LoggerLevel
- * @brief
  */
 
 #include <string>
@@ -17,6 +14,10 @@
 
 namespace ElemUtils {
 
+/**
+ * @class LoggerLevel
+ * @brief
+ */
 class LoggerLevel {
 public:
     enum Type {

include/ElementaryUtils/logger/LoggerManager.h

@@ -38,7 +38,7 @@ const std::string LOG_FOLDER_PATH = "log.folder.path";
 
 /**
  * @class LoggerManager
- * @brief \<singleton\> Use for handle logs.
+ * @brief \<singleton\> Handles logs.
  */
 class LoggerManager: public Thread {
 public:

include/ElementaryUtils/logger/LoggerMessage.h

@@ -6,9 +6,6 @@
  * @author Bryan BERTHOU (SPhN / CEA Saclay)
  * @date 05 September 2014
  * @version 1.0
- *
- * @class LoggerMessage
- * @brief
  */
 
 #include <ctime>
@@ -21,6 +18,10 @@ class LoggerMessage;
 
 namespace ElemUtils {
 
+/**
+ * @class LoggerMessage
+ * @brief
+ */
 class LoggerMessage {
 public:
     LoggerMessage(LoggerLevel level, std::string classNameSource,

include/ElementaryUtils/logger/LoggerPrintMode.h

@@ -6,9 +6,6 @@
  * @author Bryan BERTHOU (SPhN / CEA Saclay)
  * @date 05 September 2014
  * @version 1.0
- *
- * @struct LoggerPrintMode
- * @brief
  */
 
 #include <string>
@@ -17,6 +14,10 @@
 
 namespace ElemUtils {
 
+/**
+ * @struct LoggerPrintMode
+ * @brief
+ */
 class LoggerPrintMode {
 public:
     enum Type {

include/ElementaryUtils/parameters/GenericType.h

@@ -19,9 +19,9 @@ namespace ElemUtils {
 /**
  * @class GenericType
  *
- * @brief A complex object to handle different simple type (like string, int, double, bool ...) into a unique stream.
- * It used to provide a way to handle generic type.
- * Then there is a method for each simple type that you want to get back.
+ * @brief A complex object to handle different simple types (like string, int, double, bool ...) into a unique stream.
+ * It provides a way to handle a generic type.
+ * There is a method for each simple type that you want to get back.
  */
 class GenericType {
 public:

include/ElementaryUtils/parser/IniFileParser.h

@@ -8,9 +8,6 @@
  * @author <contributor> Adrien KIELB (Modulo PI - Paris)
  * @date 18 September 2014
  * Last update : 19 September 2014
- *
- * @class IniFileParser
- * @brief
  */
 
 #include <map>
@@ -18,6 +15,11 @@
 
 namespace ElemUtils {
 
+
+/**
+ * @class IniFileParser
+ * @brief
+ */
 class IniFileParser {
 public:
     static std::string SECTION_KEY_CONCATENATOR;

include/ElementaryUtils/thread/Packet.h

@@ -6,10 +6,6 @@
  * @author Bryan BERTHOU (SPhN / CEA Saclay)
  * @date 13 January 2016
  * @version 1.0
- *
- * @class Packet
- *
- * @brief FIFO
  */
 
 #include <cstddef>
@@ -18,15 +14,20 @@
 
 namespace ElemUtils {
 
+/**
+ * @class Packet
+ *
+ * @brief FIFO generic container.
+ */
 class Packet {
 public:
     /**
-     * Default constructor
+     * Default constructor.
      */
     Packet();
 
     /**
-     * Default destructor
+     * Default destructor.
      */
     virtual ~Packet();
 

include/ElementaryUtils/thread/Thread.h

@@ -6,8 +6,6 @@
  * @author Bryan BERTHOU (SPhN / CEA Saclay)
  * @author <contibutor> http://vichargrave.com/java-style-thread-class-in-c/
  * @date 10 September 2014
- *
- * @class Thread
  */
 namespace sf {
 class Thread;
@@ -15,15 +13,18 @@ class Thread;
 
 namespace ElemUtils {
 
+/**
+ * @class Thread
+ */
 class Thread {
 public:
     /**
-     * Default constructor
+     * Default constructor.
      */
     Thread();
 
     /**
-     * Default destructor
+     * Default destructor.
      */
     virtual ~Thread();
 
@@ -31,7 +32,7 @@ public:
     virtual Thread* clone() const;
 
     /**
-     * Main function executed by the thread
+     * Main function executed by the thread.
      */
     virtual void run();