Changeset 71 in pacpusframework for trunk/include/Pacpus/kernel/ComponentFactory.h


Ignore:
Timestamp:
01/10/13 15:07:34 (11 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.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • 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
Note: See TracChangeset for help on using the changeset viewer.