Changeset 115 in pacpusframework for trunk/include/Pacpus/PacpusTools/PeriodicWorker.h


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.

File:
1 edited

Legend:

Unmodified
Added
Removed

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