Show
Ignore:
Timestamp:
07/23/08 12:44:56 (4 months ago)
Author:
hlamer
Message:

Documentation for variables manager

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • v2/branches/dev/monkey/src/variablesmanager/VariablesManager.cpp

    r1860 r2188  
    2727** 
    2828****************************************************************************/ 
     29/*! 
     30        \file VariablesManager.cpp 
     31        \date 2008-01-14T00:37:18 
     32        \author Andrei KOPATS 
     33        \brief Implementation of VariablesManager class 
     34*/ 
     35 
    2936#include "VariablesManager.h" 
    3037 
     
    3441#include <QDateTime> 
    3542 
     43/*! 
     44        Class constructor 
     45        \param o Parent object. Passing to QObject constructor 
     46*/ 
    3647VariablesManager::VariablesManager( QObject* o ) 
    3748        : QObject( o ) 
    3849{} 
    3950 
     51/*! 
     52        Get value of variable 
     53        \param locals Local dictionary of variables 
     54        \return Value of variable. Empty string, if variable is unknown 
     55*/ 
    4056QString VariablesManager::getVariable (QString name, Dictionary locals) 
    4157{ 
     
    5874} 
    5975 
     76/*! 
     77        Check, if variable is set localy or globaly 
     78        \param name Name of variable 
     79        \param locals Local dictionary 
     80        \retval true Variable is set 
     81        \retval false Variable is not set 
     82*/ 
    6083bool VariablesManager::isSet (QString name, Dictionary& locals) 
    6184{ 
     
    6790} 
    6891 
    69 #include <QDebug> 
     92/*! 
     93        Replace all variables in the text by it's values 
     94        \param text Text for processing 
     95        \param locals Local dictionary of variables 
     96        return New string 
     97*/ 
    7098QString VariablesManager::replaceAllVariables (QString text, Dictionary locals) 
    7199{ 
     
    81109        findedVariables.append (s); 
    82110        p += rex.matchedLength(); 
    83                 qWarning() << "var: " << s; 
    84111    } 
    85112    // replace occurences