Show
Ignore:
Timestamp:
11/13/09 15:37:02 (14 years ago)
Author:
bhilburn
Message:

Added Doxygen documentation to headers in the include/vtcross directory.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • vtcross/trunk/src/include/vtcross/cognitive_engine.h

    r465 r518  
    1515*/ 
    1616 
    17 /* This header exports the declaration for the Cognitive Engine component type. 
     17/*! This header exports the declaration for the Cognitive Engine component type. 
    1818 */ 
    1919 
    … …  
    2525 
    2626 
    27 /* Cognitive Engine class declaration.  All public functions are inherited from 
    28  * parent classes. 
     27/*! \brief Cognitive Engine class declaration. 
     28 * 
     29 * All public functions are inherited from parent classes.  Please see parent 
     30 * class definitions for function documentation. 
    2931 */ 
    3032class CognitiveEngine : public Engine 
    3133{ 
    3234    public: 
     35        /*! Default constructor. */ 
    3336        CognitiveEngine(); 
     37 
     38        /*! Default destructor. */ 
    3439        ~CognitiveEngine(); 
    3540 
    36         /* Overloaded constructor that creates a cognitive engine object and 
     41        /*! \brief Preferred constructor. 
     42         * 
     43         * Overloaded constructor that creates a cognitive engine object and 
    3744         * connects it to either the shell or an SML, depening on the SML bool. 
    3845         */ 
    … …  
    5360 
    5461    private: 
    55         /* Receive the transmitted radio configuration from the radio itself 
    56          * (the CE will not always be local to the radio). 
    57          */ 
     62        /*! \brief Receive radio XML configuration. 
     63         *  
     64         * Receive the transmitted radio configuration from the radio itself 
     65         * (the CE will not always be local to the radio). This gets passed 
     66         * through either the Shell or the SML. */ 
    5867        void ReceiveRadioConfiguration(); 
    5968 
    60         /* Receive an 'experience' report from the radio. 
    61          */ 
     69        /*! \brief Receive an 'experience' report from the radio. 
     70         * 
     71         * An experience report can be used to build the transmission history 
     72         * for a CE just starting up so that it has a moving start regarding 
     73         * parameter optimization. */ 
    6274        void ReceiveExperience(); 
    6375 
    64         /* Find the most optimal set of transmission parameters given certain 
     76        /*! \brief Request that the CE optimize a set of parameters.  
     77         * 
     78         * Find the most optimal set of transmission parameters given certain 
    6579         * observables and possibly a service if the SML component is present 
    66          * and active. 
    67          */ 
    68         Parameter *GetSolution(Observable *observables, Parameter *currentParameters); 
    69         Parameter *GetSolution(Observable *observables, Parameter *currentParameters, \ 
    70                 std::string service); 
     80         * and active. */ 
     81        Parameter *GetSolution(Observable *observables, \ 
     82                Parameter *currentParameters); 
     83        Parameter *GetSolution(Observable *observables, \ 
     84                Parameter *currentParameters, std::string service); 
    7185 
    72         /* Receive a feedback from the radio regarding the performance of a 
     86        /*! \brief Receive feedback from the radio  
     87         * 
     88         * Receive a feedback from the radio regarding the performance of a 
    7389         * certain set of parameters, possibly associated with a service. 
    7490         * 
    … …  
    7894         * more accurate performance statistics.  
    7995         */ 
    80         void ReceiveFeedback(Observable *observables,\ 
    81                 Parameter *parameters); 
    82         void ReceiveFeedback(Observable *observables, \ 
    83                 Parameter *parameters, std::string service); 
     96        void ReceiveFeedback(Observable *observables,Parameter *parameters); 
     97        void ReceiveFeedback(Observable *observables, Parameter *parameters, \ 
     98                std::string service); 
    8499 
    85100 
    86         /* BuildCognitiveEngine performs the CE implementation specific work 
     101        /*! \brief Initialize the CE and prepare it for operation.  
     102         * 
     103         * BuildCognitiveEngine performs the CE implementation specific work 
    87104         * that defines the internals of a CE.  For example, a CBR CE engine 
    88105         * would build the case-base reasoner or create the database, a neural 
    … …  
    92109        void BuildCognitiveEngine(); 
    93110 
    94         /* The SML_present bool reflects whether or not the remote component 
     111        /*! \brief Keept track of what this CE is connected to.  
     112         * 
     113         * The SML_present bool reflects whether or not the remote component 
    95114         * this object is connected to is an SML.  If it isn't, then it must be 
    96115         * a shell.  The socketFD stores the socket file descriptor for this