Ignore:
Timestamp:
Feb 5, 2010, 9:08:33 AM (15 years ago)
Author:
Christoph Mayer
Message:

-missing doxygen in interface

File:
1 edited

Legend:

Unmodified
Added
Removed
  • source/ariba/AribaModule.h

    r7532 r7535  
    157157private:
    158158
    159         // bootstrap mechanisms
     159        /**
     160         * Available bootstrap mechanisms
     161         */
    160162        enum BootstrapMechanism {
    161163                BootstrapMechanismInvalid = 0,
     
    167169        static const string BootstrapMechanismNames[5];
    168170
    169         // bootstrap node
     171        /**
     172         * bootstrap node information
     173         */
    170174        class BootstrapNode {
    171175        public:
     
    189193        };
    190194
    191         // bootstrap info
     195        /*
     196         * bootstrap info, all bootstrap nodes
     197         * for a specific spovnet
     198         */
    192199        class BootstrapInfo {
    193200        public:
     
    203210                vector<BootstrapNode> nodes;
    204211        };
    205         vector<BootstrapInfo> bootstrapNodes;
     212
     213        vector<BootstrapInfo> bootstrapNodes; //< all available bootstrap information
    206214
    207215protected:
     
    210218        bool started; //< flag, if module has been started
    211219
    212         // bootstrap node management
     220        /**
     221         * bootstrap node management
     222         * add a bootstrap node
     223         */
    213224        void addBootstrapNode(
    214225                        const Name& spovnet,
     
    217228                        const BootstrapMechanism& mechanism
    218229                        );
     230
     231        /**
     232         * bootstrap node management
     233         * add a bootstrap node
     234         */
    219235        void addBootstrapNode(
    220236                        const Name& spovnet,
     
    222238                        );
    223239
     240        /**
     241         * bootstrap node management
     242         * get all available bootstrap mechanisms
     243         * where bootstrap nodes are available for
     244         */
    224245        vector<AribaModule::BootstrapMechanism> getBootstrapMechanisms(
    225246                        const Name& spovnet
    226247                        ) const;
    227248
     249        /**
     250         * get a endpoint descriptor for a spovnet
     251         * using a specific bootstrap mechanisms.
     252         * will currently only work with static
     253         */
    228254        const communication::EndpointDescriptor* getBootstrapNode(
    229255                        const Name& spovnet,
     
    231257                        ) const;
    232258
     259        /**
     260         * get the info field associated for a given
     261         * spovnet through a given mechanism
     262         */
    233263        string getBootstrapInfo(
    234264                        const Name& spovnet,
     
    236266                        ) const;
    237267
    238         communication::BaseCommunication* base_comm;
    239         SideportListener* sideport_sniffer;
     268        communication::BaseCommunication* base_comm; //< the base communication
     269        SideportListener* sideport_sniffer; //< the sideport listener
    240270};
    241271
Note: See TracChangeset for help on using the changeset viewer.