Changeset 7535 for source/ariba/AribaModule.h

Timestamp:

Feb 5, 2010, 9:08:33 AM (14 years ago)

Author:

Christoph Mayer

Message:

-missing doxygen in interface

File:

• source/ariba/AribaModule.h (modified) (9 diffs)

source/ariba/AribaModule.h

@@ -157 +157 @@
 private:
 
-        // bootstrap mechanisms
+        /**
+         * Available bootstrap mechanisms
+         */
         enum BootstrapMechanism {
                 BootstrapMechanismInvalid = 0,
@@ -167 +169 @@
         static const string BootstrapMechanismNames[5];
 
-        // bootstrap node
+        /**
+         * bootstrap node information
+         */
         class BootstrapNode {
         public:
@@ -189 +193 @@
         };
 
-        // bootstrap info
+        /*
+         * bootstrap info, all bootstrap nodes
+         * for a specific spovnet
+         */
         class BootstrapInfo {
         public:
@@ -203 +210 @@
                 vector<BootstrapNode> nodes;
         };
-        vector<BootstrapInfo> bootstrapNodes;
+
+        vector<BootstrapInfo> bootstrapNodes; //< all available bootstrap information
 
 protected:
@@ -210 +218 @@
         bool started; //< flag, if module has been started
 
-        // bootstrap node management
+        /**
+         * bootstrap node management
+         * add a bootstrap node
+         */
         void addBootstrapNode(
                         const Name& spovnet,
@@ -217 +228 @@
                         const BootstrapMechanism& mechanism
                         );
+
+        /**
+         * bootstrap node management
+         * add a bootstrap node
+         */
         void addBootstrapNode(
                         const Name& spovnet,
@@ -222 +238 @@
                         );
 
+        /**
+         * bootstrap node management
+         * get all available bootstrap mechanisms
+         * where bootstrap nodes are available for
+         */
         vector<AribaModule::BootstrapMechanism> getBootstrapMechanisms(
                         const Name& spovnet
                         ) const;
 
+        /**
+         * get a endpoint descriptor for a spovnet
+         * using a specific bootstrap mechanisms.
+         * will currently only work with static
+         */
         const communication::EndpointDescriptor* getBootstrapNode(
                         const Name& spovnet,
@@ -231 +257 @@
                         ) const;
 
+        /**
+         * get the info field associated for a given
+         * spovnet through a given mechanism
+         */
         string getBootstrapInfo(
                         const Name& spovnet,
@@ -236 +266 @@
                         ) const;
 
-        communication::BaseCommunication* base_comm;
-        SideportListener* sideport_sniffer;
+        communication::BaseCommunication* base_comm; //< the base communication
+        SideportListener* sideport_sniffer; //< the sideport listener
 };