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/policy_engine.h

    r465 r518  
    1515*/ 
    1616 
    17 /* This header exports the declaration for the Policy Engine component type. 
     17/*! This header exports the declaration for the Policy Engine component type. 
    1818 */ 
    1919 
    … …  
    2525 
    2626 
    27 /* Policy Engine class declaration.  All public functions are inherited from 
    28  * parent classes. 
     27/*! \brief Policy Engine class declaration.   
     28 * 
     29 * All public functions are inherited from parent classes Engine and Component. 
     30 * Please see those class documentation files for further information regarding 
     31 * public functions. 
    2932 */ 
    3033class PolicyEngine : public Engine 
    3134{ 
    3235    public: 
     36        /*! \brief Default Policy Engine Constructor */ 
    3337        PolicyEngine(); 
     38 
     39        /*! \brief Default Policy Engine Destructor */ 
    3440        ~PolicyEngine(); 
    3541 
    36         /* Overloaded constructor that creates a policy engine object and 
     42        /*! \brief Preferred Policy Engine Constructor.  
     43         * 
     44         * Overloaded constructor that creates a policy engine object and 
    3745         * connects it to either the shell or an SML, depening on the SML bool. 
    3846         */ 
    … …  
    5361 
    5462    private: 
    55         /* Parse and load/reload policies into the policy engine. 
    56          */ 
     63        /*! \brief Parse and load/reload policies into the policy engine. */ 
    5764        void LoadPolicies(); 
    5865        void ReloadPolicies(); 
    5966 
    60         /* Return a decision made by the policy engine regarding a certain set 
     67        /*! \brief Return a validation decision. 
     68         * 
     69         * Return a decision made by the policy engine regarding a certain set 
    6170         * of transmission parameters. 
    6271         */ 
    … …  
    6473                int32_t decision_array[]); 
    6574 
    66         /* Validate a set of transmission parameters received from the radio. 
     75        /*! \brief Perform parameter validation. 
     76         * 
     77         * Validate a set of transmission parameters received from the radio. 
    6778         */ 
    6879        void ValidateParameters(); 
    6980 
    70         /* The SML_present bool reflects whether or not the remote component 
     81        /*! \brief Keep track of what control component this PE is connected to. 
     82         * 
     83         * The SML_present bool reflects whether or not the remote component 
    7184         * this object is connected to is an SML.  If it isn't, then it must be 
    7285         * a shell.  The socketFD stores the socket file descriptor for this