diff options
| -rw-r--r-- | ACE/ChangeLog | 9 | ||||
| -rw-r--r-- | ACE/ace/Connector.h | 10 | ||||
| -rw-r--r-- | ACE/ace/Malloc_Base.h | 2 | ||||
| -rw-r--r-- | ACE/ace/SString.h | 8 | ||||
| -rw-r--r-- | ACE/ace/Stream.h | 14 | ||||
| -rw-r--r-- | ACE/ace/Task.h | 18 |
6 files changed, 35 insertions, 26 deletions
diff --git a/ACE/ChangeLog b/ACE/ChangeLog index 65291befe78..7fccd62f8ee 100644 --- a/ACE/ChangeLog +++ b/ACE/ChangeLog @@ -1,3 +1,12 @@ +Mon Jul 12 08:19:58 UTC 2010 Johnny Willemsen <jwillemsen@remedy.nl> + + * ace/Connector.h: + * ace/Malloc_Base.h: + * ace/SString.h: + * ace/Stream.h: + * ace/Task.h: + Fixed set of doxygen warnings + Fri Jul 09 09:35:30 UTC 2010 Martin Corino <mcorino@remedy.nl> * bin/PerlACE/Process_Unix.pm: diff --git a/ACE/ace/Connector.h b/ACE/ace/Connector.h index 5d77ae430e4..6e7a274c5a4 100644 --- a/ACE/ace/Connector.h +++ b/ACE/ace/Connector.h @@ -424,7 +424,7 @@ public: SUPER; /** - * Initialize a connector. @a flags indicates how <SVC_HANDLER>'s + * Initialize a connector. @a flags indicates how SVC_HANDLER's * should be initialized prior to being activated. Right now, the * only flag that is processed is ACE_NONBLOCK, which enabled * non-blocking I/O on the SVC_HANDLER when it is opened. @@ -535,21 +535,21 @@ protected: /// Creation strategy for an Connector. CREATION_STRATEGY *creation_strategy_; - /// true if Connector created the creation strategy and thus should + /// True if Connector created the creation strategy and thus should /// delete it, else false. bool delete_creation_strategy_; /// Connect strategy for a Connector. CONNECT_STRATEGY *connect_strategy_; - /// true if Connector created the connect strategy and thus should + /// True if Connector created the connect strategy and thus should /// delete it, else false. bool delete_connect_strategy_; - /// Concurrency strategy for an <Connector>. + /// Concurrency strategy for a Connector. CONCURRENCY_STRATEGY *concurrency_strategy_; - /// true if Connector created the concurrency strategy and thus should + /// True if Connector created the concurrency strategy and thus should /// delete it, else false. bool delete_concurrency_strategy_; }; diff --git a/ACE/ace/Malloc_Base.h b/ACE/ace/Malloc_Base.h index e9e15923737..490fa78c0a9 100644 --- a/ACE/ace/Malloc_Base.h +++ b/ACE/ace/Malloc_Base.h @@ -73,7 +73,7 @@ public: size_type elem_size, char initial_value = '\0') = 0; - /// Free <ptr> (must have been allocated by <ACE_Allocator::malloc>). + /// Free @a ptr (must have been allocated by ACE_Allocator::malloc()). virtual void free (void *ptr) = 0; /// Remove any resources associated with this memory manager. diff --git a/ACE/ace/SString.h b/ACE/ace/SString.h index c9a94c7165e..900c8143a88 100644 --- a/ACE/ace/SString.h +++ b/ACE/ace/SString.h @@ -145,7 +145,7 @@ public: /// Constructor that copies @a s into dynamically allocated memory. ACE_SString (const char *s, ACE_Allocator *alloc = 0); - /// Constructor that copies @a len chars of @s into dynamically + /// Constructor that copies @a len chars of @a s into dynamically /// allocated memory (will NUL terminate the result). ACE_SString (const char *s, size_type len, ACE_Allocator *alloc = 0); @@ -195,7 +195,7 @@ public: /// Get the underlying pointer. const char *fast_rep (void) const; - /// Same as STL String's <c_str> and <fast_rep>. + /// Same as STL String's c_str() and fast_rep(). const char *c_str (void) const; /// Comparison operator that will match substrings. Returns the @@ -230,7 +230,7 @@ public: /// Inequality comparison operator. bool operator != (const ACE_SString &s) const; - /// Performs a <strcmp>-style comparison. + /// Performs a strcmp()-style comparison. int compare (const ACE_SString &s) const; /// Dump the state of an object. @@ -243,7 +243,7 @@ private: /// Pointer to a memory allocator. ACE_Allocator *allocator_; - /// Length of the ACE_SString (not counting the trailing '\0'). + /// Length of the ACE_SString (not counting the trailing '\\0'). size_type len_; /// Pointer to data. diff --git a/ACE/ace/Stream.h b/ACE/ace/Stream.h index 2dc24b6da13..1caed488777 100644 --- a/ACE/ace/Stream.h +++ b/ACE/ace/Stream.h @@ -37,8 +37,8 @@ class ACE_Time_Value; * @brief This class is the primary abstraction for the ASX framework. * It is moduled after System V Stream. * - * A Stream consists of a stack of <ACE_Modules>, each of which - * contains two <ACE_Tasks>. Even though the methods in this + * A Stream consists of a stack of @c ACE_Modules, each of which + * contains two @c ACE_Tasks. Even though the methods in this * class are virtual, this class isn't really intended for * subclassing unless you know what you are doing. In * particular, the ACE_Stream destructor calls <close>, which @@ -53,7 +53,7 @@ public: enum { - /// Indicates that <close> deletes the Tasks. Don't change this + /// Indicates that @c close() deletes the Tasks. Don't change this /// value without updating the same enum in class ACE_Module... M_DELETE = 3 }; @@ -88,7 +88,7 @@ public: // = ACE_Stream plumbing operations /// Add a new module @a mod right below the Stream head. The - /// <open()> hook methods of the <ACE_Tasks> in this ACE_Module + /// @c open() hook methods of the @c ACE_Tasks in this ACE_Module /// are invoked to initialize the tasks. virtual int push (ACE_Module<ACE_SYNCH_USE> *mod); @@ -101,7 +101,7 @@ public: /// head). virtual int top (ACE_Module<ACE_SYNCH_USE> *&mod); - /// Insert a new module @a mod below the named module <prev_name>. + /// Insert a new module @a mod below the named module @a prev_name. virtual int insert (const ACE_TCHAR *prev_name, ACE_Module<ACE_SYNCH_USE> *mod); @@ -111,7 +111,7 @@ public: int flags = M_DELETE); /// Remove the named module @a mod from the stream. This bypasses the - /// strict LIFO ordering of <push> and <pop>. + /// strict LIFO ordering of @c push and @c pop. virtual int remove (const ACE_TCHAR *mod, int flags = M_DELETE); @@ -218,7 +218,7 @@ public: int advance (void); private: - /// Next <Module> that we haven't yet seen. + /// Next ACE_Module that we haven't yet seen. ACE_Module<ACE_SYNCH_USE> *next_; }; diff --git a/ACE/ace/Task.h b/ACE/ace/Task.h index 757cf651323..3eb6ef246e3 100644 --- a/ACE/ace/Task.h +++ b/ACE/ace/Task.h @@ -84,21 +84,21 @@ public: /** * Hook called from ACE_Thread_Exit when during thread exit and from - * the default implementation of <module_closed>. In general, this + * the default implementation of @c module_closed(). In general, this * method shouldn't be called directly by an application, - * particularly if the <Task> is running as an Active Object. - * Instead, a special message should be passed into the <Task> via - * the <put> method defined below, and the <svc> method should - * interpret this as a flag to shut down the <Task>. + * particularly if the Task is running as an Active Object. + * Instead, a special message should be passed into the Task via + * the put() method defined below, and the svc() method should + * interpret this as a flag to shut down the Task. */ virtual int close (u_long flags = 0); /** - * Hook called during <ACE_Module::close>. The default + * Hook called during ACE_Module::close(). The default * implementation calls forwards the call to close(1). Please - * notice the changed value of the default argument of <close>. + * notice the changed value of the default argument of close(). * This allows tasks to differ between the call has been originated - * from <ACE_Thread_Exit> or from <module_closed>. Be aware that + * from ACE_Thread_Exit or from module_closed(). Be aware that * close(0) will be also called when a thread associated with the * ACE_Task instance exits. */ @@ -111,7 +111,7 @@ public: /// A hook method that can be used to pass a message to a /// task, where it can be processed immediately or queued for subsequent - /// processing in the <svc> hook method. + /// processing in the svc() hook method. virtual int put (ACE_Message_Block *, ACE_Time_Value * = 0); /// Run by a daemon thread to handle deferred processing. |