diff options
| -rw-r--r-- | ace/Active_Map_Manager.h | 8 | ||||
| -rw-r--r-- | ace/Arg_Shifter.h | 8 | ||||
| -rw-r--r-- | ace/Based_Pointer_Repository.cpp | 23 | ||||
| -rw-r--r-- | ace/CDR_Stream.h | 4 | ||||
| -rw-r--r-- | ace/Caching_Utility_T.h | 19 | ||||
| -rw-r--r-- | ace/Configuration.h | 88 | ||||
| -rw-r--r-- | ace/DEV_IO.h | 2 | ||||
| -rw-r--r-- | ace/Dev_Poll_Reactor.h | 2 | ||||
| -rw-r--r-- | ace/Dirent_Selector.h | 2 | ||||
| -rw-r--r-- | ace/Env_Value_T.h | 2 | ||||
| -rw-r--r-- | ace/FILE.h | 6 | ||||
| -rw-r--r-- | ace/Future.h | 12 | ||||
| -rw-r--r-- | ace/Get_Opt.h | 2 | ||||
| -rw-r--r-- | ace/Hashable.h | 6 | ||||
| -rw-r--r-- | ace/IO_Cntl_Msg.cpp | 11 | ||||
| -rw-r--r-- | ace/Init_ACE.h | 12 | ||||
| -rw-r--r-- | ace/Local_Tokens.h | 113 |
17 files changed, 168 insertions, 152 deletions
diff --git a/ace/Active_Map_Manager.h b/ace/Active_Map_Manager.h index 881e8d99382..7c0ef680ef2 100644 --- a/ace/Active_Map_Manager.h +++ b/ace/Active_Map_Manager.h @@ -44,12 +44,16 @@ public: ACE_Active_Map_Manager_Key (ACE_UINT32 slot_index, ACE_UINT32 slot_generation); - /// Get/Set the <slot_index>. + /// Get the <slot_index>. ACE_UINT32 slot_index (void) const; + + /// Set the <slot_index>. void slot_index (ACE_UINT32 i); - /// Get/Set the <slot_generation> number. + /// Get the <slot_generation> number. ACE_UINT32 slot_generation (void) const; + + /// Set the <slot_generation> number. void slot_generation (ACE_UINT32 g); /// Size required to store information about active key. diff --git a/ace/Arg_Shifter.h b/ace/Arg_Shifter.h index e87a916c594..6ab4b893b7a 100644 --- a/ace/Arg_Shifter.h +++ b/ace/Arg_Shifter.h @@ -6,7 +6,7 @@ * * $Id$ * - * @author Seth Widoff + * @author Seth Widoff */ //============================================================================= @@ -143,12 +143,12 @@ public: */ int cur_arg_strncasecmp (const ACE_TCHAR *flag); - /// Consume <number> argument(s) by sticking them/it on the end of + /// Consume @a number argument(s) by sticking them/it on the end of /// the vector. int consume_arg (int number = 1); - /// Place <number> arguments in the same relative order ahead of the - /// known arguemnts in the vector. + /// Place @a number arguments in the same relative order ahead of the + /// known arguments in the vector. int ignore_arg (int number = 1); /// Returns the number of args left to see in the vector. diff --git a/ace/Based_Pointer_Repository.cpp b/ace/Based_Pointer_Repository.cpp index ba1283fb41a..ad6917d8a30 100644 --- a/ace/Based_Pointer_Repository.cpp +++ b/ace/Based_Pointer_Repository.cpp @@ -3,28 +3,29 @@ #include "ace/Map_Manager.h" #include "ace/Based_Pointer_Repository.h" +/** + * @class ACE_Based_Pointer_Repository_Rep + * + * @brief Implementation for the <ACE_Based_Pointer_Repository>. + * + * Every memory pool in ACE binds it's mapping base address and + * the mapped size to this repository every time it maps/remaps a + * new chunk of memory successfully. + */ class ACE_Based_Pointer_Repository_Rep { - // = TITLE - // Implementation for the <ACE_Based_Pointer_Repository>. - // - // = DESCRIPTION - // Every memory pool in ACE binds it's mapping base address and - // the mapped size to this repository every time it maps/remaps a - // new chunk of memory successfully. - public: // Useful typedefs. typedef ACE_Map_Manager <void *, size_t, ACE_Null_Mutex> MAP_MANAGER; typedef ACE_Map_Iterator < void *, size_t, ACE_Null_Mutex> MAP_ITERATOR; typedef ACE_Map_Entry <void *, size_t> MAP_ENTRY; + /// Keeps track of the mapping between addresses and their associated + /// values. MAP_MANAGER addr_map_; - // Keeps track of the mapping between addresses and their associated - // values. + /// Synchronize concurrent access to the map. ACE_SYNCH_MUTEX lock_; - // Synchronize concurrent access to the map. }; ACE_Based_Pointer_Repository::ACE_Based_Pointer_Repository (void) diff --git a/ace/CDR_Stream.h b/ace/CDR_Stream.h index 001799b5706..e7fb9c09902 100644 --- a/ace/CDR_Stream.h +++ b/ace/CDR_Stream.h @@ -326,7 +326,7 @@ public: /** * Returns (in <buf>) the next position in the buffer aligned to * <size>, it advances the Message_Block wr_ptr past the data - * (i.e. <buf> + <size>). If necessary it grows the Message_Block + * (i.e., <buf> + <size>). If necessary it grows the Message_Block * buffer. Sets the good_bit to 0 and returns a -1 on failure. */ int adjust (size_t size, @@ -804,7 +804,7 @@ public: /** * Returns (in <buf>) the next position in the buffer aligned to * <size>, it advances the Message_Block rd_ptr past the data - * (i.e. <buf> + <size>). Sets the good_bit to 0 and returns a -1 + * (i.e., <buf> + <size>). Sets the good_bit to 0 and returns a -1 * on failure. */ int adjust (size_t size, diff --git a/ace/Caching_Utility_T.h b/ace/Caching_Utility_T.h index 8f22710fd28..53f48f6f16e 100644 --- a/ace/Caching_Utility_T.h +++ b/ace/Caching_Utility_T.h @@ -47,21 +47,20 @@ public: typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY; + /// Constructor. ACE_Pair_Caching_Utility (ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_strategy = 0, int delete_cleanup_strategy = 0); - // Constructor. - /// Destructor. ~ACE_Pair_Caching_Utility (void); + /** + * Purge entries from the <container>. The Cleanup_Strategy will do the actual + * job of cleanup once the entries to be cleaned up are decided. + */ int clear_cache (CONTAINER &container, double purge_percent); - // Purge entries from the <container>. The Cleanup_Strategy will do - // the actual job of cleanup once the entries to be cleaned up are - // decided. - protected: /// Find the entry with minimum caching attributes. @@ -106,11 +105,10 @@ public: typedef ACE_Recyclable_Handler_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY; typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY_BASE; + /// Constructor. ACE_Recyclable_Handler_Caching_Utility (ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_strategy = 0, int delete_cleanup_strategy = 0); - // Constructor. - /// Destructor. ~ACE_Recyclable_Handler_Caching_Utility (void); @@ -167,11 +165,10 @@ public: typedef ACE_Refcounted_Recyclable_Handler_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY; typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY_BASE; + /// Constructor. ACE_Refcounted_Recyclable_Handler_Caching_Utility (ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_strategy = 0, int delete_cleanup_strategy = 0); - // Constructor. - /// Destructor. ~ACE_Refcounted_Recyclable_Handler_Caching_Utility (void); @@ -303,7 +300,7 @@ public: /** * Purge entries from the <container>. The Cleanup_Strategy will do * the actual job of cleanup once the entries to be cleaned up are - * decided. NOte: Here it is a no-op. + * decided. Note: Here it is a no-op. */ int clear_cache (CONTAINER &container, double purge_percent); diff --git a/ace/Configuration.h b/ace/Configuration.h index c404add645b..d0d85f18fd0 100644 --- a/ace/Configuration.h +++ b/ace/Configuration.h @@ -94,17 +94,17 @@ public: /// Default ctor ACE_Configuration_Section_Key (void); - /// ctor based on a pointer to a concrete internal key, does an + /// Ctor based on a pointer to a concrete internal key, does an /// add_ref on <key>. ACE_EXPLICIT ACE_Configuration_Section_Key (ACE_Section_Key_Internal *key); /// Copy ctor, does an add_ref on rhs.key_. ACE_Configuration_Section_Key (const ACE_Configuration_Section_Key &rhs); - /// destructor, does a <dec_ref> on <key_>. + /// Destructor, does a <dec_ref> on <key_>. ~ACE_Configuration_Section_Key (void); - /// assignment operator, does a <dec_ref> on <key_> and <add_ref> to + /// Assignment operator, does a <dec_ref> on <key_> and <add_ref> to /// <rhs.key_> ACE_Configuration_Section_Key & operator= (const ACE_Configuration_Section_Key &rhs); @@ -131,7 +131,7 @@ public: INVALID }; - /// destructor + /// Destructor virtual ~ACE_Configuration (void); /// Returns the root section of this configuration. @@ -154,7 +154,7 @@ public: int recursive) = 0; /** - * method to enumerate through the <name> and <type> of values in a + * Method to enumerate through the <name> and <type> of values in a * <key>. To begin iteration, <index> must be zero. to continue * iteration, invoke enumerate_values again while incrementing * index. Each iteration will return the <name> of the value and @@ -169,7 +169,7 @@ public: VALUETYPE& type) = 0; /** - * method to enumerate through the <name> subsections in <key>. To + * Method to enumerate through the <name> subsections in <key>. To * begin iteration, <index> must zero. to continue iteration, invoke * enumerate_sections again while incrementing index. Each * iteration will return the <name> of the sub section. This method @@ -181,37 +181,37 @@ public: virtual int enumerate_sections (const ACE_Configuration_Section_Key& key, int index, ACE_TString& name) = 0; - /// sets the value in <key> with <name> to a string of <value> + /// Sets the value in <key> with <name> to a string of <value> virtual int set_string_value (const ACE_Configuration_Section_Key& key, const ACE_TCHAR* name, const ACE_TString& value) = 0; - /// sets the value in <key> with <name> to an integer of <value> + /// Sets the value in <key> with <name> to an integer of <value> virtual int set_integer_value (const ACE_Configuration_Section_Key& key, const ACE_TCHAR* name, u_int value) = 0; - /// sets the value in <key> with <name> to binary data of <data> with + /// Sets the value in <key> with <name> to binary data of <data> with /// <length>. virtual int set_binary_value (const ACE_Configuration_Section_Key& key, const ACE_TCHAR* name, const void* data, u_int length) = 0; - /// gets the string value of <name> from <key> and places it in + /// Gets the string value of <name> from <key> and places it in /// <value>. Returns non zero on error (if value is not a string). virtual int get_string_value (const ACE_Configuration_Section_Key& key, const ACE_TCHAR* name, ACE_TString& value) = 0; - /// gets the integer value of <name> from <key> and places it in + /// Gets the integer value of <name> from <key> and places it in /// <value>. Returns non zero on error (if value is not an integer). virtual int get_integer_value (const ACE_Configuration_Section_Key& key, const ACE_TCHAR* name, u_int& value) = 0; /** - * gets the binary value of <name> from <key> and places a copy in + * Gets the binary value of <name> from <key> and places a copy in * <data> and sets <length> to the length of the data. caller is * responsible for deleting <data>. Returns non zero on error (if * value is not binary). @@ -222,7 +222,7 @@ public: u_int& length) = 0; /** - * checks to see if an entry of <name> is in <key> and places the + * Checks to see if an entry of <name> is in <key> and places the * data type in <type>. Returns 0 on success (entry is found), * -1 on error */ @@ -283,12 +283,12 @@ protected: /// Default ctor ACE_Configuration (void); - /// resolves the internal key from a section key + /// Resolves the internal key from a section key ACE_Section_Key_Internal* get_internal_key (const ACE_Configuration_Section_Key& key); /** - * tests to see if <name> is valid. <name> must be < 255 characters + * Tests to see if <name> is valid. <name> must be < 255 characters * and not contain the path separator '\', brackets [] or = (maybe * just restrict to alphanumeric?) returns non zero if name is not * valid @@ -315,13 +315,13 @@ protected: class ACE_Export ACE_Section_Key_Win32 : public ACE_Section_Key_Internal { public: - /// constructor based on an HKEY + /// Constructor based on an HKEY ACE_Section_Key_Win32 (HKEY hKey); HKEY hKey_; protected: - /// destructor - invokes <RegCloseKey> + /// Destructor - invokes <RegCloseKey> virtual ~ACE_Section_Key_Win32 (void); // Not used @@ -343,13 +343,13 @@ class ACE_Export ACE_Configuration_Win32Registry : public ACE_Configuration public: /** - * constructor for registry configuration database. hKey is the + * Constructor for registry configuration database. hKey is the * base registry key to attach to. This class takes ownership of * hKey, it will invoke <RegCloseKey> on it upon destruction. */ ACE_EXPLICIT ACE_Configuration_Win32Registry (HKEY hKey); - /// destructor + /// Destructor virtual ~ACE_Configuration_Win32Registry (void); virtual int open_section (const ACE_Configuration_Section_Key& base, @@ -449,19 +449,19 @@ typedef ACE_Allocator_Adapter <ACE_Malloc <ACE_LOCAL_MEMORY_POOL, class ACE_Export ACE_Configuration_ExtId { public: - /// defeault ctor + /// Defeault ctor ACE_Configuration_ExtId (void); - /// named constructor + /// Named constructor ACE_EXPLICIT ACE_Configuration_ExtId (const ACE_TCHAR* name); - /// copy ctor + /// Copy ctor ACE_Configuration_ExtId (const ACE_Configuration_ExtId& rhs); /// destructor ~ACE_Configuration_ExtId (void); - /// assignment operator + /// Assignment operator ACE_Configuration_ExtId& operator= (const ACE_Configuration_ExtId& rhs); /// Equality comparison operator (must match name_). @@ -508,22 +508,22 @@ typedef ACE_Hash_Map_Entry<ACE_Configuration_ExtId, int> class ACE_Export ACE_Configuration_Value_IntId { public: - /// default constructor + /// Default constructor ACE_Configuration_Value_IntId (void); - /// string constructor, takes ownership of string + /// String constructor, takes ownership of string ACE_EXPLICIT ACE_Configuration_Value_IntId (ACE_TCHAR* string); - /// integer constructor + /// Integer constructor ACE_EXPLICIT ACE_Configuration_Value_IntId (u_int integer); - /// binary constructor, takes ownership of data + /// Binary constructor, takes ownership of data ACE_Configuration_Value_IntId (void* data, u_int length); - /// copy ctor + /// Copy ctor ACE_Configuration_Value_IntId (const ACE_Configuration_Value_IntId& rhs); - /// destructor + /// Destructor ~ACE_Configuration_Value_IntId (void); /// Assignment operator @@ -535,14 +535,14 @@ public: // = Data members. /** - * points to the string value or binary data or IS the integer + * Points to the string value or binary data or IS the integer * (XXX need to change this since sizeof (u_int) is * not the same accross different platforms) * Length is only used when type_ == BINARY */ ACE_Configuration::VALUETYPE type_; void* data_; - u_int length_; + u_int length_; }; typedef ACE_Hash_Map_With_Allocator<ACE_Configuration_ExtId, @@ -568,24 +568,24 @@ typedef ACE_Hash_Map_Entry<ACE_Configuration_ExtId, class ACE_Export ACE_Configuration_Section_IntId { public: - /// default ctor + /// Default ctor ACE_Configuration_Section_IntId (void); - /// named ctor + /// Named ctor ACE_EXPLICIT ACE_Configuration_Section_IntId (VALUE_MAP* value_hash_map, SUBSECTION_MAP* section_hash_map); - /// copy ctor + /// Copy ctor ACE_Configuration_Section_IntId (const ACE_Configuration_Section_IntId& rhs); - /// destructor + /// Destructor ~ACE_Configuration_Section_IntId (void); - /// asignment operator + /// Assignment operator ACE_Configuration_Section_IntId& operator= ( const ACE_Configuration_Section_IntId& rhs); - /// frees the hash table and all its values + /// Frees the hash table and all its values void free (ACE_Allocator *alloc); // = Data Members. @@ -619,10 +619,10 @@ class ACE_Export ACE_Configuration_Section_Key_Heap : public ACE_Section_Key_Internal { public: - /// constructor based on the full path of the section + /// Constructor based on the full path of the section ACE_Configuration_Section_Key_Heap (const ACE_TCHAR* path); - ///the path itself + /// The path itself ACE_TCHAR* path_; /// The value iterator @@ -631,7 +631,7 @@ public: /// The sub section iterator SUBSECTION_HASH::ITERATOR* section_iter_; protected: - /// destructor - will delete the iterators + /// Destructor - will delete the iterators virtual ~ACE_Configuration_Section_Key_Heap (void); // Not used @@ -662,15 +662,15 @@ public: /// Default ctor ACE_Configuration_Heap (void); - /// destructor + /// Destructor virtual ~ACE_Configuration_Heap (void); - /// opens a configuration based on a file name + /// Opens a configuration based on a file name int open (const ACE_TCHAR* file_name, void* base_address = ACE_DEFAULT_BASE_ADDR, int default_map_size = ACE_DEFAULT_CONFIG_SECTION_SIZE); - /// opens a heap based configuration + /// Opens a heap based configuration int open (int default_map_size = ACE_DEFAULT_CONFIG_SECTION_SIZE); virtual int open_section (const ACE_Configuration_Section_Key& base, @@ -725,7 +725,7 @@ public: const ACE_TCHAR* name); private: - /// adds a new section + /// Adds a new section int add_section (const ACE_Configuration_Section_Key& base, const ACE_TCHAR* sub_section, ACE_Configuration_Section_Key& result); diff --git a/ace/DEV_IO.h b/ace/DEV_IO.h index 5c262ba61ec..b0b593fb280 100644 --- a/ace/DEV_IO.h +++ b/ace/DEV_IO.h @@ -7,7 +7,7 @@ * $Id$ * * @author Gerhard Lenzer - @ @author Douglas C. Schmidt + * @author Douglas C. Schmidt */ //============================================================================= diff --git a/ace/Dev_Poll_Reactor.h b/ace/Dev_Poll_Reactor.h index da5f61bbd78..3a559554df2 100644 --- a/ace/Dev_Poll_Reactor.h +++ b/ace/Dev_Poll_Reactor.h @@ -718,7 +718,7 @@ public: virtual int resume_handlers (void); /// Does the reactor allow the application to resume the handle on - /// its own, i.e. can it pass on the control of handle resumption to + /// its own, i.e., can it pass on the control of handle resumption to /// the application. virtual int resumable_handler (void); diff --git a/ace/Dirent_Selector.h b/ace/Dirent_Selector.h index 4dcfd945b5b..64fc78c30ab 100644 --- a/ace/Dirent_Selector.h +++ b/ace/Dirent_Selector.h @@ -21,7 +21,7 @@ #endif /* ACE_LACKS_PRAGMA_ONCE */ /** - * @class ACE_Dirent + * @class ACE_Dirent_Selector * * @brief Define a portable C++ directory-entry iterator based on the * POSIX @param scandir API. diff --git a/ace/Env_Value_T.h b/ace/Env_Value_T.h index 00d01aae531..c08e789bade 100644 --- a/ace/Env_Value_T.h +++ b/ace/Env_Value_T.h @@ -55,7 +55,7 @@ public: /// Returns the value as type T. operator T (void); - /// The constructor, read <varname> from the enviroment, using + /// The constructor, read <varname> from the environment, using /// <vardefault> as its value if it is not defined. void open (const ACE_TCHAR *varname, const T &defval); diff --git a/ace/FILE.h b/ace/FILE.h index e9fbfc1d749..d1fd37211ea 100644 --- a/ace/FILE.h +++ b/ace/FILE.h @@ -43,13 +43,13 @@ class ACE_Export ACE_FILE_Info { public: - /// mode of file + /// Mode of file mode_t mode_; - /// no of links + /// No of links nlink_t nlink_; - /// size of file + /// Size of file off_t size_; }; diff --git a/ace/Future.h b/ace/Future.h index e5c5545fbf0..7f66bb9ddfa 100644 --- a/ace/Future.h +++ b/ace/Future.h @@ -69,7 +69,7 @@ template <class T> class ACE_Future_Observer { public: - // = Destructor + /// Destructor virtual ~ACE_Future_Observer (void); /// Called by the ACE_Future in which we are subscribed to when @@ -80,7 +80,7 @@ public: ACE_ALLOC_HOOK_DECLARE; protected: - // = Constructor + /// Constructor ACE_Future_Observer (void); }; @@ -116,7 +116,7 @@ private: ACE_Time_Value *tv) const; /** - * Attaches the specified observer to a subject (i.e. the <ACE_Future_Rep>). + * Attaches the specified observer to a subject (i.e., the <ACE_Future_Rep>). * The update method of the specified subject will be invoked with a copy of * the written-to <ACE_Future> as input when the result gets set. * @@ -127,7 +127,7 @@ private: ACE_Future<T> &caller); /** - * Detaches the specified observer from a subject (i.e. the <ACE_Future_Rep>). + * Detaches the specified observer from a subject (i.e., the <ACE_Future_Rep>). * The update method of the specified subject will not be invoked when the * <ACE_Future_Rep>s result gets set. Returns 1 if the specified observer was * actually attached to the subject prior to this call and 0 if was not. @@ -303,7 +303,7 @@ public: int ready (void) const; /** - * Attaches the specified observer to a subject (i.e. the <ACE_Future>). + * Attaches the specified observer to a subject (i.e., the <ACE_Future>). * The update method of the specified subject will be invoked with a copy of * the associated <ACE_Future> as input when the result gets set. If the * result is already set when this method gets invoked, then the update @@ -315,7 +315,7 @@ public: int attach (ACE_Future_Observer<T> *observer); /** - * Detaches the specified observer from a subject (i.e. the <ACE_Future_Rep>). + * Detaches the specified observer from a subject (i.e., the <ACE_Future_Rep>). * The update method of the specified subject will not be invoked when the * <ACE_Future_Reps> result gets set. Returns 1 if the specified observer * was actually attached to the subject prior to this call and 0 if was not. diff --git a/ace/Get_Opt.h b/ace/Get_Opt.h index ff36c3acdcf..8854d2c596b 100644 --- a/ace/Get_Opt.h +++ b/ace/Get_Opt.h @@ -122,7 +122,7 @@ public: * @c EOF is returned as soon as a non-option argument * is found. @c opt_ind() will return the index of the * next @a argv element so the program can continue - * processing the rest of the @ argv elements. + * processing the rest of the @a argv elements. * @arg PERMUTE_ARGS (default) means the @a argv * elements are reordered dynamically (permuted) so * that all options appear first. When the last diff --git a/ace/Hashable.h b/ace/Hashable.h index 8e6fb2d00c1..a6b264d29f3 100644 --- a/ace/Hashable.h +++ b/ace/Hashable.h @@ -23,11 +23,9 @@ /** - * @class ACE_Recyclable - * - * @brief - * + * @class ACE_Hashable * + * @brief ACE_Hashable */ class ACE_Export ACE_Hashable { diff --git a/ace/IO_Cntl_Msg.cpp b/ace/IO_Cntl_Msg.cpp index aa8281f63d4..66903626b63 100644 --- a/ace/IO_Cntl_Msg.cpp +++ b/ace/IO_Cntl_Msg.cpp @@ -9,14 +9,13 @@ ACE_RCSID(ace, IO_Cntl_Msg, "$Id$") // Forward decl template <class SYNCH> class ACE_Module; - +/** + * @class ACE_Module_Link + * + * @brief Data structure used to link two modules together + */ class ACE_Module_Link { - // = TITLE - // Data structure used to link two modules together - // - // = DESCRIPTION - // public: ACE_Module_Link (ACE_Module *m1, ACE_Module *m2): mod_upper_ (m1), mod_lower_ (m2), count_ (0) {} diff --git a/ace/Init_ACE.h b/ace/Init_ACE.h index a81d5d21343..cda0abe6ff6 100644 --- a/ace/Init_ACE.h +++ b/ace/Init_ACE.h @@ -34,25 +34,27 @@ class ACE_Export ACE_Init_ACE { public: - /// Returns 0 on success, -1 on failure, and 1 if it had already been called. /** - * This class implements the fucntions for the initialization and + * This class implements the functions for the initialization and * shutting down ACE. These functions are called only once per ACE * invokation. + * @return Returns 0 on success, -1 on failure, and 1 if it had already been + * called. */ static int init (void); - /// Returns 0 on success, -1 on failure, and 1 if it had already been called. /** * Shut down ACE library services. Can be called only once per * program invocation. + * @return Returns 0 on success, -1 on failure, and 1 if it had already been + * called. */ static int fini (void); private: /** - * Counter to match <init>/<fini> calls. <init> must increment it; - * <fini> must decrement it. <fini> then does nothing until it + * Counter to match <init()>/<fini()> calls. <init()> must increment it; + * <fini()> must decrement it. <fini()> then does nothing until it * reaches 0. */ static unsigned int init_fini_count_; diff --git a/ace/Local_Tokens.h b/ace/Local_Tokens.h index e64762e0bd5..878f6ba6bac 100644 --- a/ace/Local_Tokens.h +++ b/ace/Local_Tokens.h @@ -69,7 +69,7 @@ * * @brief Not a public interface. * - * Constant definitions and typdefs for Token library. Mostly, + * Constant definitions and typedefs for Token library. Mostly, * this class is necessary to fight the compiler with order of * declaration errors. */ @@ -108,39 +108,47 @@ public: /// Null constructor. ACE_TPQ_Entry (void); - /// Construction. + /// Constructor. ACE_TPQ_Entry (const ACE_Token_Proxy *proxy, const ACE_TCHAR *client_id); /// Copy constructor. ACE_TPQ_Entry (const ACE_TPQ_Entry &rhs); - /// Death. + /// Destructor. ~ACE_TPQ_Entry (void); /// Copy operator use by the queue. void operator= (const ACE_TPQ_Entry &rhs); - // = Set/get top of the queue. + /// Get top of the queue. ACE_Token_Proxy *proxy (void) const; + + /// Set top of the queue. void proxy (ACE_Token_Proxy *); - // = Delta/get nesting level of the entry. + /// Get nesting level of the entry. int nesting_level (void) const; + + /// Delta nesting level of the entry. void nesting_level (int delta); - // = Set/get client_id of the entry. + /// Get client_id of the entry. const ACE_TCHAR *client_id (void) const; + + /// Set client_id of the entry. void client_id (const ACE_TCHAR *); - /// Returns 1 if <id> == client id. Does not check for <id> == 0. + /// Returns 1 if @a id == client id. Does not check for @a id == 0. int equal_client_id (const ACE_TCHAR *id); /// One method for arg and sleep_hook. void set (void (*sleep_hook)(void *)); - // = Set/get sleep hook of the entry. + /// Set sleep hook of the entry. void sleep_hook (void (*sh)(void *)); + + /// Get sleep hook of the entry. PTVF sleep_hook (void) const; /// Call the sleep hook function or method passing arg. @@ -156,8 +164,10 @@ public: /// Pointer to next in list. ACE_TPQ_Entry *next_; - // = Get/set whether this client is blocked waiting for a token. + /// Get whether this client is blocked waiting for a token. int waiting (void) const; + + /// Set whether this client is blocked waiting for a token. void waiting (int w); private: @@ -228,9 +238,11 @@ private: // = These are passed to the constructor of ACE_TPQ_Entry in // make_TSS_TYPE + /// Proxy. - /// Client_id. const ACE_Token_Proxy *proxy_; + + /// Client_id. const ACE_TCHAR *client_id_; }; @@ -247,7 +259,7 @@ class ACE_Token_Proxy_Queue; class ACE_Export ACE_TPQ_Iterator { public: - /// Construction. + /// Constructor. ACE_TPQ_Iterator (ACE_Token_Proxy_Queue &q); /// Destructor. @@ -289,10 +301,10 @@ class ACE_Export ACE_Token_Proxy_Queue public: friend class ACE_TPQ_Iterator; - /// Construction. + /// Constructor. ACE_Token_Proxy_Queue (void); - /// Destructor + /// Destructor. ~ACE_Token_Proxy_Queue (void); /** @@ -312,7 +324,7 @@ public: /// Remove the top waiter. void dequeue (void); - /// Remove the waiter whose proxy ref matches remove_me. + /// Remove the waiter whose proxy ref matches @a remove_me. void remove (const ACE_TPQ_Entry *remove_me); /// The number of waiters. @@ -322,13 +334,13 @@ public: void dump (void) const; protected: - /** - * Head. - * Tail. - * Size. - */ + /// Head. ACE_TPQ_Entry *head_; + + /// Tail. ACE_TPQ_Entry *tail_; + + /// Size. int size_; }; @@ -341,7 +353,7 @@ protected: * Not a public interface. * Currently, I don't see a reason for providing an abstract * interface at this level of the library. As of yet, no one - * uses <ACE_Tokens< derivatives through this abstract interface + * uses <ACE_Tokens> derivatives through this abstract interface * except for <ACE_Token_Manager>. It only uses the statistical * methods which are shared by all Tokens. For that reason, it * still makes since to have a common base class. However, @@ -481,10 +493,10 @@ class ACE_Local_Mutex; class ACE_Export ACE_Mutex_Token : public ACE_Tokens { public: - /// life + /// Constructor ACE_EXPLICIT ACE_Mutex_Token (const ACE_TCHAR* name); - /// death + /// Destructor virtual ~ACE_Mutex_Token (void); // = Synchronization operations. @@ -503,7 +515,7 @@ public: int ignore_deadlock, int notify); - /// same as acquire, but fails if would block + /// Same as acquire, but fails if would block virtual int tryacquire (ACE_TPQ_Entry *caller); /** @@ -576,10 +588,10 @@ private: class ACE_Export ACE_RW_Token : public ACE_Tokens { public: - /// Life. + /// Constructor. ACE_EXPLICIT ACE_RW_Token (const ACE_TCHAR* name); - /// Death. + /// Destructor. virtual ~ACE_RW_Token (void); // = Synchronization operations. @@ -591,14 +603,14 @@ public: * Returns 0 on success, -1 on failure with <ACE_Log_Msg::errnum> as * the reason. If errnum == EWOULDBLOCK, and notify == 1, * <ACE_Token_Proxy::sleep_hook> has been called on the current - * owner of the token. If ignore_deadlock is passed as 1 and errnum - * == EDEADLK, then deadlock was detected via ace_token_manager. + * owner of the token. If @a ignore_deadlock is passed as 1 and errnum + * == EDEADLK, then deadlock was detected via ACE_Token_Manager. */ virtual int acquire (ACE_TPQ_Entry *caller, int ignore_deadlock, int notify); - /// same as acquire except fails on would block + /// Same as acquire except fails on would block virtual int tryacquire (ACE_TPQ_Entry *caller); /** @@ -651,7 +663,7 @@ public: virtual int is_owner (const ACE_TCHAR *id); protected: - /// the number of waiting writers. + /// The number of waiting writers. int num_writers_; /// ACE_Mutex_Token used to lock internal data structures. @@ -682,7 +694,7 @@ public: /// Copy construction. ACE_Token_Name (const ACE_Token_Name &rhs); - /// Death. + /// Destructor. virtual ~ACE_Token_Name (void); /// Copy. @@ -691,10 +703,10 @@ public: /// Comparison. int operator== (const ACE_Token_Name &rhs) const; - /// Token name. + /// Get the token name. const ACE_TCHAR *name (void) const; - /// Token name. + /// Set the token name. void name (const ACE_TCHAR *new_name); /// Dump the state of the class. @@ -741,13 +753,14 @@ public: /// Construction. ACE_Token_Proxy (void); - /// Death. + /// Destructor. virtual ~ACE_Token_Proxy (void); /** - * <name> is the string uniquely identifying the token. - * <ignore_deadlock> can be 1 to disable deadlock notifications. - * <debug> prints debug messages. + * Open the <ACE_Token>/ + * @arg name The string uniquely identifying the token. + * @arg ignore_deadlock Can be 1 to disable deadlock notifications. + * @arg debug Prints debug messages. */ virtual int open (const ACE_TCHAR *name, int ignore_deadlock = 0, @@ -767,8 +780,7 @@ public: ACE_Synch_Options &options = ACE_Synch_Options::defaults); - /// Calls renew on the token. Blocks the calling thread if would - /// block. + /// Calls renew on the token. Blocks the calling thread if would block. virtual int renew (int requeue_position = -1, ACE_Synch_Options &options = ACE_Synch_Options::defaults); @@ -840,7 +852,7 @@ public: /// waiters list and given the token. virtual void token_acquired (ACE_TPQ_Entry *); - /// the client id of the current token holder + /// The client id of the current token holder virtual const ACE_TCHAR *owner_id (void); /// Return a dynamically allocated clone of the derived class. @@ -897,7 +909,7 @@ public: /// Construction. ACE_Null_Token (void); - /// Destructor + /// Destructor. ~ACE_Null_Token (void); #endif /* ACE_LACKS_INLINE_FUNCTION */ @@ -956,9 +968,10 @@ class ACE_Export ACE_Local_Mutex : public ACE_Token_Proxy { public: /** - * <token_name> uniquely id's the token. - * <ignore_deadlock> will allow deadlock to occur (useful for - * testing). <debug> prints a bunch of messages. + * Constructor. + * @arg token_name Uniquely id's the token. + * @arg ignore_deadlock Will allow deadlock to occur (useful for testing). + * @arg debug Prints a bunch of messages. */ ACE_Local_Mutex (const ACE_TCHAR *token_name = 0, int ignore_deadlock = 0, @@ -1009,9 +1022,10 @@ public: // = Initialization and termination. /** - * <token_name> uniquely id's the token. - * <ignore_deadlock> will allow deadlock to occur (useful for - * testing). <debug> prints a bunch of messages. + * Constructor. + * @arg token_name Uniquely id's the token. + * @arg ignore_deadlock Will allow deadlock to occur (useful for testing). + * @arg debug Prints a bunch of messages. */ ACE_Local_RLock (const ACE_TCHAR *token_name = 0, int ignore_deadlock = 0, @@ -1065,9 +1079,10 @@ public: // = Initialization and termination. /** - * <token_name> uniquely id's the token. - * <ignore_deadlock> will allow deadlock to occur (useful for - * testing). <debug> prints a bunch of messages. + * Constructor. + * @arg token_name Uniquely id's the token. + * @arg ignore_deadlock Will allow deadlock to occur (useful for testing). + * @arg debug Prints a bunch of messages. */ ACE_Local_WLock (const ACE_TCHAR *token_name = 0, int ignore_deadlock = 0, |