Changeset 21023

Show
Ignore:
Timestamp:
02/09/08 22:09:54 (7 months ago)
Author:
patrick
Message:

MFT r21022 (partial): Expanded API documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/branches/2.2/modules/tweek/tweek/CORBA/CorbaManager.h

    r20634 r21023  
    7373 
    7474   /** 
    75     * Initializes the ORB and POA associated with this object.  A child POA of 
    76     * the root POA (RootPOA) is created, and all servants registered with this 
    77     * manager are activated within that child POA. 
     75    * Initializes the ORB and POA associated with this object for use with the 
     76    * CORBA Naming Service. A child POA of the root POA (RootPOA) is created, 
     77    * and all servants registered with this manager are activated within that 
     78    * child POA. 
     79    * 
     80    * @pre This CorbaManager object has not been initialized previously. 
    7881    * 
    7982    * @param localID     A string providing a unique identifier for the local 
    80     *                    POA. 
     83    *                    POA. When used, "tweek_" will be prepended to this 
     84    *                    value, but user-level code should generally not need 
     85    *                    to worry aubot that detail. 
    8186    * @param argc        The size of the following argument vector.  This will 
    8287    *                    be modified if any elements are removed from argv. 
    …… 
    99104    *                    the Naming Service.  Common values are "1.0" and 
    100105    *                    "1.2".  It defaults to "1.0". 
     106    * 
     107    * @return \c true is returned if initialization completes successfully. 
     108    *         Otherwise, \c false is returned. 
    101109    */ 
    102110   bool init(const std::string& localID, int& argc, char** argv, 
    …… 
    209217} // End of tweek namespace 
    210218 
     219 
    211220#endif /* _TWEEK_CORBA_MANAGER_H_ */