Commit e02c83aa authored by Nabil Chouika's avatar Nabil Chouika
Browse files

Documentation

- Generate tagfile to be used by NumA and PARTONS documentations.
- Some fixed to avoid conflicts with namespaces in documentation.
parent 85c13402
...@@ -780,7 +780,7 @@ WARN_LOGFILE = ...@@ -780,7 +780,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # 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 # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
...@@ -1015,7 +1015,7 @@ USE_HTAGS = NO ...@@ -1015,7 +1015,7 @@ USE_HTAGS = NO
# See also: Section \class. # See also: Section \class.
# The default value is: YES. # The default value is: YES.
VERBATIM_HEADERS = YES VERBATIM_HEADERS = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index # Configuration options related to the alphabetical class index
...@@ -2071,7 +2071,7 @@ TAGFILES = ...@@ -2071,7 +2071,7 @@ TAGFILES =
# tag file that is based on the input files it reads. See section "Linking to # 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. # 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 # 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 # the class index. If set to NO, only the inherited external classes will be
......
/html/
/ElementaryUtilsDoxygen.tag
...@@ -20,7 +20,7 @@ namespace ElemUtils { ...@@ -20,7 +20,7 @@ namespace ElemUtils {
/** /**
* @class PropertiesManager * @class PropertiesManager
* @brief \<singleton\> Use for handle properties from configuration's file. * @brief \<singleton\> Handles properties from configuration file.
*/ */
class PropertiesManager { class PropertiesManager {
public: public:
......
...@@ -8,10 +8,6 @@ ...@@ -8,10 +8,6 @@
* @version 1.0 * @version 1.0
* *
* Last update : 15 September 2014 * Last update : 15 September 2014
*
* @struct FileExceptionType
*
* @brief
*/ */
#include <string> #include <string>
...@@ -19,6 +15,12 @@ ...@@ -19,6 +15,12 @@
namespace ElemUtils { namespace ElemUtils {
//TODO refactoring //TODO refactoring
/**
* @struct FileExceptionType
*
* @brief
*/
struct FileExceptionType { struct FileExceptionType {
//prevent automatic conversion for any other built-in types such as bool, int, etc //prevent automatic conversion for any other built-in types such as bool, int, etc
template<typename T> template<typename T>
......
...@@ -7,10 +7,6 @@ ...@@ -7,10 +7,6 @@
* @version 2.0 * @version 2.0
* @date 28/04/2009 * @date 28/04/2009
* @date Updated 18/09/2014 * @date Updated 18/09/2014
*
* @class FileUtils
*
* @brief Handle file system
*/ */
#include <fstream> // needed #include <fstream> // needed
...@@ -23,6 +19,11 @@ ...@@ -23,6 +19,11 @@
namespace ElemUtils { namespace ElemUtils {
/*!
* @class FileUtils
*
* @brief Handle file system.
*/
class FileUtils { class FileUtils {
public: public:
...@@ -30,7 +31,7 @@ public: ...@@ -30,7 +31,7 @@ public:
/** /**
* By default open a file in write mode. * 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 fileOutputStream
* @param filePath * @param filePath
......
...@@ -6,9 +6,6 @@ ...@@ -6,9 +6,6 @@
* @author Bryan BERTHOU (SPhN / CEA Saclay) * @author Bryan BERTHOU (SPhN / CEA Saclay)
* @date 12 September 2014 * @date 12 September 2014
* @version 1.0 * @version 1.0
*
* @class LoggerClassLevel
* @brief
*/ */
#include <map> #include <map>
...@@ -18,6 +15,11 @@ ...@@ -18,6 +15,11 @@
namespace ElemUtils { namespace ElemUtils {
/**
* @class LoggerClassLevel
* @brief
*/
class LoggerClassLevel { class LoggerClassLevel {
public: public:
LoggerClassLevel(const std::string& className, LoggerClassLevel(const std::string& className,
......
...@@ -6,9 +6,6 @@ ...@@ -6,9 +6,6 @@
* @author Bryan BERTHOU (SPhN / CEA Saclay) * @author Bryan BERTHOU (SPhN / CEA Saclay)
* @date 05 September 2014 * @date 05 September 2014
* @version 1.0 * @version 1.0
*
* @class LoggerLevel
* @brief
*/ */
#include <string> #include <string>
...@@ -17,6 +14,10 @@ ...@@ -17,6 +14,10 @@
namespace ElemUtils { namespace ElemUtils {
/**
* @class LoggerLevel
* @brief
*/
class LoggerLevel { class LoggerLevel {
public: public:
enum Type { enum Type {
......
...@@ -38,7 +38,7 @@ const std::string LOG_FOLDER_PATH = "log.folder.path"; ...@@ -38,7 +38,7 @@ const std::string LOG_FOLDER_PATH = "log.folder.path";
/** /**
* @class LoggerManager * @class LoggerManager
* @brief \<singleton\> Use for handle logs. * @brief \<singleton\> Handles logs.
*/ */
class LoggerManager: public Thread { class LoggerManager: public Thread {
public: public:
......
...@@ -6,9 +6,6 @@ ...@@ -6,9 +6,6 @@
* @author Bryan BERTHOU (SPhN / CEA Saclay) * @author Bryan BERTHOU (SPhN / CEA Saclay)
* @date 05 September 2014 * @date 05 September 2014
* @version 1.0 * @version 1.0
*
* @class LoggerMessage
* @brief
*/ */
#include <ctime> #include <ctime>
...@@ -21,6 +18,10 @@ class LoggerMessage; ...@@ -21,6 +18,10 @@ class LoggerMessage;
namespace ElemUtils { namespace ElemUtils {
/**
* @class LoggerMessage
* @brief
*/
class LoggerMessage { class LoggerMessage {
public: public:
LoggerMessage(LoggerLevel level, std::string classNameSource, LoggerMessage(LoggerLevel level, std::string classNameSource,
......
...@@ -6,9 +6,6 @@ ...@@ -6,9 +6,6 @@
* @author Bryan BERTHOU (SPhN / CEA Saclay) * @author Bryan BERTHOU (SPhN / CEA Saclay)
* @date 05 September 2014 * @date 05 September 2014
* @version 1.0 * @version 1.0
*
* @struct LoggerPrintMode
* @brief
*/ */
#include <string> #include <string>
...@@ -17,6 +14,10 @@ ...@@ -17,6 +14,10 @@
namespace ElemUtils { namespace ElemUtils {
/**
* @struct LoggerPrintMode
* @brief
*/
class LoggerPrintMode { class LoggerPrintMode {
public: public:
enum Type { enum Type {
......
...@@ -19,9 +19,9 @@ namespace ElemUtils { ...@@ -19,9 +19,9 @@ namespace ElemUtils {
/** /**
* @class GenericType * @class GenericType
* *
* @brief A complex object to handle different simple type (like string, int, double, bool ...) into a unique stream. * @brief A complex object to handle different simple types (like string, int, double, bool ...) into a unique stream.
* It used to provide a way to handle generic type. * It provides a way to handle a generic type.
* Then there is a method for each simple type that you want to get back. * There is a method for each simple type that you want to get back.
*/ */
class GenericType { class GenericType {
public: public:
......
...@@ -8,9 +8,6 @@ ...@@ -8,9 +8,6 @@
* @author <contributor> Adrien KIELB (Modulo PI - Paris) * @author <contributor> Adrien KIELB (Modulo PI - Paris)
* @date 18 September 2014 * @date 18 September 2014
* Last update : 19 September 2014 * Last update : 19 September 2014
*
* @class IniFileParser
* @brief
*/ */
#include <map> #include <map>
...@@ -18,6 +15,11 @@ ...@@ -18,6 +15,11 @@
namespace ElemUtils { namespace ElemUtils {
/**
* @class IniFileParser
* @brief
*/
class IniFileParser { class IniFileParser {
public: public:
static std::string SECTION_KEY_CONCATENATOR; static std::string SECTION_KEY_CONCATENATOR;
......
...@@ -6,10 +6,6 @@ ...@@ -6,10 +6,6 @@
* @author Bryan BERTHOU (SPhN / CEA Saclay) * @author Bryan BERTHOU (SPhN / CEA Saclay)
* @date 13 January 2016 * @date 13 January 2016
* @version 1.0 * @version 1.0
*
* @class Packet
*
* @brief FIFO
*/ */
#include <cstddef> #include <cstddef>
...@@ -18,15 +14,20 @@ ...@@ -18,15 +14,20 @@
namespace ElemUtils { namespace ElemUtils {
/**
* @class Packet
*
* @brief FIFO generic container.
*/
class Packet { class Packet {
public: public:
/** /**
* Default constructor * Default constructor.
*/ */
Packet(); Packet();
/** /**
* Default destructor * Default destructor.
*/ */
virtual ~Packet(); virtual ~Packet();
......
...@@ -6,8 +6,6 @@ ...@@ -6,8 +6,6 @@
* @author Bryan BERTHOU (SPhN / CEA Saclay) * @author Bryan BERTHOU (SPhN / CEA Saclay)
* @author <contibutor> http://vichargrave.com/java-style-thread-class-in-c/ * @author <contibutor> http://vichargrave.com/java-style-thread-class-in-c/
* @date 10 September 2014 * @date 10 September 2014
*
* @class Thread
*/ */
namespace sf { namespace sf {
class Thread; class Thread;
...@@ -15,15 +13,18 @@ class Thread; ...@@ -15,15 +13,18 @@ class Thread;
namespace ElemUtils { namespace ElemUtils {
/**
* @class Thread
*/
class Thread { class Thread {
public: public:
/** /**
* Default constructor * Default constructor.
*/ */
Thread(); Thread();
/** /**
* Default destructor * Default destructor.
*/ */
virtual ~Thread(); virtual ~Thread();
...@@ -31,7 +32,7 @@ public: ...@@ -31,7 +32,7 @@ public:
virtual Thread* clone() const; virtual Thread* clone() const;
/** /**
* Main function executed by the thread * Main function executed by the thread.
*/ */
virtual void run(); virtual void run();
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment