Changeset 115 in pacpusframework


Ignore:
Timestamp:
06/25/13 11:37:38 (11 years ago)
Author:
Marek Kurdej
Message:

[doc] Added: Pacpus API reference main page.
Fixed: example sections in doc.

Location:
trunk
Files:
1 added
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/doxyfile.in

    r71 r115  
    669669# with spaces.
    670670
    671 INPUT                  = @PACPUS_INCLUDE_DIR@
     671INPUT                  = @PACPUS_INCLUDE_DIR@ @PACPUS_DOC_DIR@
    672672
    673673# This tag can be used to specify the character encoding of the source files

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

    r106 r115  
    1919#include <Pacpus/PacpusTools/AsyncWorkerBase.h>
    2020
    21 
    2221class QTimer;
    2322
    2423namespace pacpus
    2524{
    26   /** PeriodicWorker
    27    * @brief A simple base class for periodic worker.
    28    *
    29    * @example
    30    *    class MyWorker
    31    *      : public PeriodicWorkder
    32    *    {
    33    *      public:
    34    *        void doWork() { std::cout << "Hey, I'm working!" << std::endl; }
    35    *    };
    36    *
    37    *    // Do its work every second.
    38    *    MyWorker worker;
    39    *    worker.startWork(1000);
    40    */
    41   class PACPUSTOOLS_API PeriodicWorker
    42     : public AsyncWorkerBase
    43   {
     25    /// @brief A simple base class for periodic worker.
     26    ///
     27    /// @example
     28    /// To use the PeriodicWorker, simply inherit from this class when creating your worker.
     29    /// ~~~
     30    /// class MyWorker
     31    ///     : public PeriodicWorkder
     32    /// {
     33    /// public:
     34    ///     void doWork() { std::cout << "Hey, I'm working!" << std::endl; }
     35    /// };
     36    ///
     37    /// // Do its work every second.
     38    /// MyWorker worker;
     39    /// worker.startWork(1000);
     40    /// ~~~
     41    class PACPUSTOOLS_API PeriodicWorker
     42        : public AsyncWorkerBase
     43    {
    4444    Q_OBJECT
    4545    public:

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

    r76 r115  
    3232/// @param factoryName   Name of the class in the factory.
    3333/// @example
     34/// ~~~
    3435///     REGISTER_COMPONENT("DummyComponent", DummyComponent);
     36/// ~~~
    3537/// @see pacpus::ComponentFactory
    3638#define REGISTER_COMPONENT(className, factoryName) \

  • trunk/src/PacpusLib/PacpusApplication.cpp

    r114 r115  
    44// %pacpus:license}
    55/// @file
    6 /// @author  Marek Kurdej <marek.kurdej@utc.fr>
     6/// @author  Marek Kurdej <firstname.surname@utc.fr>
    77/// @date    March, 2013
    88/// @version $Id$
Note: See TracChangeset for help on using the changeset viewer.