Changeset 71 in pacpusframework for trunk/include/Pacpus


Ignore:
Timestamp:
Jan 10, 2013, 3:07:34 PM (12 years ago)
Author:
Marek Kurdej
Message:

Added: more documentation.
doc/doxyfile.in: turned on BUILTIN_STL_SUPPORT in Doxygen.
Added: LICENSE-header.txt to be included in all source files.

Location:
trunk/include/Pacpus
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/Pacpus/PacpusTools/geodesie.h

    r70 r71  
     1// %pacpus:license{
    12// This file is part of the PACPUS framework distributed under the
    23// CECILL-C License, Version 1.0.
    3 //
     4// %}
    45/// @file
    56/// @author  Firstname Surname <firstname.surname@utc.fr>
    … …  
    3031#endif
    3132
    32 ////////////////////////////////////////////////////////////////////////
    3333/// 9x9 matrix ???
    3434///

  • trunk/include/Pacpus/kernel/ComponentFactory.h

    r66 r71  
    2525#include <QString>
    2626
    27 /** Register a component to the factory.
    28  * @className Name of the class, without the quotes.
    29  * @factoryName Name of the class in the factory.
    30  */
     27/// @def REGISTER_COMPONENT(className, factoryName)
     28/// Registers a component to the factory.
     29///
     30/// @param className     Name of the class, without the quotes.
     31/// @param factoryName   Name of the class in the factory.
     32/// @example
     33///     REGISTER_COMPONENT("DummyComponent", DummyComponent);
     34/// @see pacpus::ComponentFactory
    3135#define REGISTER_COMPONENT(className, factoryName) \
    3236  static pacpus::ComponentFactory<className> sFactory(factoryName)
    … …  
    3438namespace pacpus {
    3539
    36 /** ComponentFactory
    37  * @brief Use it to interface your components with the application.
    38  *
    39  * @example
    40  *   REGISTER_COMPONENT("DummyComponent", DummyComponent);
    41  */
     40/// Use it to interface your components with the application.
     41///
     42/// @tparam T   Component class
     43/// @see #REGISTER_COMPONENT(className, factoryName)
    4244template <typename T>
    4345class ComponentFactory

  • trunk/include/Pacpus/kernel/ComponentManager.h

    r67 r71  
    3131class ComponentBase;
    3232
     33/// @todo Documentation
    3334typedef QMap<QString, ComponentBase *> ComponentMap;
     35/// @todo Documentation
    3436typedef QMap<QString, ComponentFactoryBase *> FactoryMap;
    3537
    36 /** ComponentManager
    37  * @brief Singleton recording the components and managing them.
    38  */
     38/// Singleton recording the components and managing them.
    3939class ComponentManager
    4040{
    … …  
    4343public:
    4444    /// @returns a pointer to the ComponentManager object
    45     /// @deprecated use getInstance()
     45    /// @deprecated Use getInstance()
    4646    PACPUS_DEPRECATED_MSG( static PACPUSLIB_API ComponentManager * create(), "use 'getInstance()'" );
    4747
    48     /** Get the singleton of the ComponentManager class.
    49      * @return Pointer to the ComponentManager singleton.
    50      */
     48    /// Returns an instance of the singleton ComponentManager class.
     49    /// @returns Pointer to the ComponentManager singleton.
    5150    static PACPUSLIB_API ComponentManager* getInstance();
    5251
    53     /** Destroy the ComponentManager singleton.
    54      * After this call, every pointer to the ComponentManager becomes invalid.
    55      */
     52    /// Destroys the ComponentManager singleton.
     53    ///
     54    /// After this call, every pointer to the ComponentManager becomes invalid.
    5655    static PACPUSLIB_API void destroy();
    5756

  • trunk/include/Pacpus/kernel/DbiteFile.h

    r67 r71  
    2727/// @todo Documentation
    2828struct FILELIB_API VariableDataSizeTag {};
     29/// @todo Documentation
    2930FILELIB_API extern VariableDataSizeTag VariableDataSize;
    3031
    3132/// @todo Documentation
    3233struct FILELIB_API ReadModeTag {};
     34/// @todo Documentation
    3335FILELIB_API extern ReadModeTag ReadMode;
    3436
    3537/// @todo Documentation
    3638struct FILELIB_API WriteModeTag {};
     39/// @todo Documentation
    3740FILELIB_API extern WriteModeTag WriteMode;
    3841
    3942/// @todo Documentation
    4043struct FILELIB_API DiagnoseModeTag {};
     44/// @todo Documentation
    4145FILELIB_API extern DiagnoseModeTag DiagnoseMode;
    4246

  • trunk/include/Pacpus/kernel/FileLibConfig.h

    r66 r71  
    1010///
    1111/// DLL import/export macro definitions file.
    12 /// Declares <library name>_API macro as __declspec(dllexport) or __declspec(dllimport)
     12/// Declares \<library name\>_API macro as __declspec(dllexport) or __declspec(dllimport)
    1313/// on Windows system and as an empty macro on other systems.
    14 /// DLL exporting is performed when <library name>_EXPORTS is defined.
     14/// DLL exporting is performed when \<library name\>_EXPORTS is defined.
    1515
    1616#ifndef DEF_PACPUS_FILELIBCONFIG_H

  • trunk/include/Pacpus/kernel/Log.h

    r66 r71  
    1919namespace pacpus {
    2020
     21/// Static log facility initializer
     22///
     23/// Uses Schwarz counter (nifty counter) idiom to initialize the log before
     24/// other static objects that could use the log.
    2125static class PACPUSLIB_API LogConfigurator
    2226{
    … …  
    3135
    3236#ifdef PACPUS_USE_LOG
    33   // Includes, log4cxx.
    3437  #include <log4cxx/logger.h>
    3538
    3639  class QString;
    37 
    38   /** Declare a log4cxx logger
    39    * @param name Name of the logger, displayed when logging a message.
    40    */
     40 
    4141  #define DECLARE_STATIC_LOGGER(name) \
    4242    static log4cxx::LoggerPtr logger(log4cxx::Logger::getLogger(name))
    4343
    44   // Macros making logging user friendly.
    4544  #define LOG_TRACE(message)          LOG4CXX_TRACE(logger, message)
    4645  #define LOG_DEBUG(message)          LOG4CXX_DEBUG(logger, message)
    … …  
    5049  #define LOG_FATAL(message)          LOG4CXX_FATAL(logger, message)
    5150
    52   // Provides helpers to log a QString.
     51  /// Output stream ::log4cxx::helpers::CharMessageBuffer operator for QString
    5352  PACPUSLIB_API ::log4cxx::helpers::CharMessageBuffer & operator<<(::log4cxx::helpers::CharMessageBuffer & os, const QString & s);
     53  /// Output stream ::log4cxx::helpers::MessageBuffer operator for QString
    5454  PACPUSLIB_API ::log4cxx::helpers::CharMessageBuffer & operator<<(::log4cxx::helpers::MessageBuffer & os, const QString & s);
     55
    5556#else
     57  /// Declares a log4cxx logger
     58  ///
     59  /// @param name Name of the logger, displayed when logging a message.
    5660  #define DECLARE_STATIC_LOGGER(name)
     61  /// Logs a message at TRACE level using default logger
    5762  #define LOG_TRACE(message)
     63  /// Logs a message at DEBUG level using default logger
    5864  #define LOG_DEBUG(message)
     65  /// Logs a message at INFO level using default logger
    5966  #define LOG_INFO(message)
     67  /// Logs a message at WARN level using default logger
    6068  #define LOG_WARN(message)
     69  /// Logs a message at ERROR level using default logger
    6170  #define LOG_ERROR(message)
     71  /// Logs a message at FATAL level using default logger
    6272  #define LOG_FATAL(message)
    6373#endif // PACPUS_USE_LOG

  • trunk/include/Pacpus/kernel/pacpus.h

    r70 r71  
    1919/// Pi math constant
    2020///
    21 /// @deprecated,use M_PI from cmath.
     21/// @deprecated Use M_PI from \<cmath\>.
    2222#ifndef PACPUS_PI
    2323#   define PACPUS_PI       3.1415926
Note: See TracChangeset for help on using the changeset viewer.