Changeset 53 in pacpusframework


Ignore:
Timestamp:
Jan 9, 2013, 9:39:48 AM (12 years ago)
Author:
Marek Kurdej
Message:

Added: doc todo comments.

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/Pacpus/DbitePlayer/DbtPlyEngineStateChart.h

    r31 r53  
    2424{
    2525public:
     26    /// @todo Documentation
    2627    virtual ~DbtPlyEngineState();
    27 
     28   
     29    /// @todo Documentation
    2830    virtual void play(DbtPlyEngine & engine);
     31    /// @todo Documentation
    2932    virtual void pause(DbtPlyEngine & engine);
     33    /// @todo Documentation
    3034    virtual void stop(DbtPlyEngine & engine);
    31 
     35   
     36    /// @todo Documentation
    3237    virtual void speedUp(DbtPlyEngine & engine);
     38    /// @todo Documentation
    3339    virtual void speedDown(DbtPlyEngine & engine);
    34 
     40   
     41    /// @todo Documentation
    3542    virtual bool isPlaying();
    36 
     43   
     44    /// @todo Documentation
    3745    virtual QString toString() const = 0;
    3846
    3947protected:
     48    /// @todo Documentation
    4049    DbtPlyEngineState();
    4150};
     
    4655{
    4756public:
     57    /// @todo Documentation
    4858    virtual void pause(DbtPlyEngine & engine);
     59    /// @todo Documentation
    4960    virtual void stop(DbtPlyEngine & engine);
    50 
     61   
     62    /// @todo Documentation
    5163    virtual bool isPlaying();
    52 
     64   
     65    /// @todo Documentation
    5366    virtual QString toString() const;
     67    /// @todo Documentation
    5468    static DbtPlyEngineState * getInstance();
    5569
     
    6478{
    6579public:
     80    /// @todo Documentation
    6681    virtual void play(DbtPlyEngine & engine);
     82    /// @todo Documentation
    6783    virtual void stop(DbtPlyEngine & engine);
    68 
     84   
     85    /// @todo Documentation
    6986    virtual QString toString() const;
     87    /// @todo Documentation
    7088    static DbtPlyEngineState * getInstance();
    7189
     
    8098{
    8199public:
     100    /// @todo Documentation
    82101    virtual void play(DbtPlyEngine & engine);
    83 
     102   
     103    /// @todo Documentation
    84104    virtual QString toString() const;
     105    /// @todo Documentation
    85106    static DbtPlyEngineState * getInstance();
    86107
  • trunk/include/Pacpus/kernel/XmlConfigFile.h

    r31 r53  
    3232
    3333public:
     34    /// @todo Documentation
    3435    static XmlConfigFile * create();
     36    /// @todo Documentation
    3537    static void destroy();
     38    /// @todo Documentation
    3639    QDomElement getComponent(QString name);
     40    /// @returns a list of all names of components declared in the XML tree
    3741    QStringList getAllComponents();
     42    /// @todo Documentation
    3843    QStringList getAllPlugins();
     44    /// @todo Documentation
    3945    int loadFile(QString fileName);
    4046
    41     // not used
     47    /// @todo Documentation
     48    /// not used
    4249    void saveFile(QString fileName);
    43     // not used
     50    /// @todo Documentation
     51    /// not used
    4452    void addComponent(QDomElement component);
    45     // not used
     53    /// @todo Documentation
     54    /// not used
    4655    void delComponent(QDomElement component);
    4756
  • trunk/src/PacpusLib/XmlConfigFile.cpp

    r31 r53  
    175175}
    176176
    177 /// @return a list of all names of components declared in the XML tree
    178177QStringList XmlConfigFile::getAllComponents()
    179178{
Note: See TracChangeset for help on using the changeset viewer.