summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohnny Willemsen <jwillemsen@remedy.nl>2007-05-24 07:55:50 +0000
committerJohnny Willemsen <jwillemsen@remedy.nl>2007-05-24 07:55:50 +0000
commitc9ef547e6cb8a2d4fb74cc256c125482a18f0570 (patch)
treeeaac20ba19d505bb98cc22857396b51d780bded5
parent1334f93dda7ddb001d065692e887b4d31ed980c2 (diff)
downloadATCD-c9ef547e6cb8a2d4fb74cc256c125482a18f0570.tar.gz
Thu May 24 07:54:55 UTC 2007 Johnny Willemsen <jwillemsen@remedy.nl>
-rw-r--r--ACE/ChangeLog42
-rw-r--r--ACE/ace/ATM_Addr.h4
-rw-r--r--ACE/ace/Array_Base.h18
-rw-r--r--ACE/ace/Barrier.h2
-rw-r--r--ACE/ace/Based_Pointer_Repository.h2
-rw-r--r--ACE/ace/Configuration.h10
-rw-r--r--ACE/ace/DLL_Manager.h2
-rw-r--r--ACE/ace/FILE.h2
-rw-r--r--ACE/ace/Free_List.h2
-rw-r--r--ACE/ace/INET_Addr.h4
-rw-r--r--ACE/ace/IO_SAP.h2
-rw-r--r--ACE/ace/Local_Memory_Pool.h8
-rw-r--r--ACE/ace/Log_Record.h4
-rw-r--r--ACE/ace/MMAP_Memory_Pool.h4
-rw-r--r--ACE/ace/Malloc_Base.h40
-rw-r--r--ACE/ace/Map_Manager.h2
-rw-r--r--ACE/ace/Mem_Map.h8
-rw-r--r--ACE/ace/Message_Queue_T.h2
-rw-r--r--ACE/ace/Pagefile_Memory_Pool.h4
-rw-r--r--ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h2
-rw-r--r--ACE/ace/RW_Process_Mutex.h2
-rw-r--r--ACE/ace/Reactor_Impl.h2
-rw-r--r--ACE/ace/Registry.h44
-rw-r--r--ACE/ace/Remote_Tokens.h2
-rw-r--r--ACE/ace/SOCK_Dgram.h4
-rw-r--r--ACE/ace/SPIPE_Connector.h2
-rw-r--r--ACE/ace/SPIPE_Stream.h2
-rw-r--r--ACE/ace/Sbrk_Memory_Pool.h2
-rw-r--r--ACE/ace/Service_Gestalt.h6
-rw-r--r--ACE/ace/Shared_Memory_Pool.h6
-rw-r--r--ACE/ace/Signal.h32
-rw-r--r--ACE/ace/Timer_Heap_T.h12
-rw-r--r--ACE/ace/Timer_Wheel_T.h4
-rw-r--r--ACE/ace/Unbounded_Set.h2
-rw-r--r--ACE/ace/WFMO_Reactor.h10
35 files changed, 167 insertions, 129 deletions
diff --git a/ACE/ChangeLog b/ACE/ChangeLog
index 7d899837dbd..95c4cf06c86 100644
--- a/ACE/ChangeLog
+++ b/ACE/ChangeLog
@@ -1,3 +1,41 @@
+Thu May 24 07:54:55 UTC 2007 Johnny Willemsen <jwillemsen@remedy.nl>
+
+ * ace/Array_Base.h:
+ * ace/ATM_Addr.h:
+ * ace/Barrier.h:
+ * ace/Based_Pointer_Repository.h:
+ * ace/Configuration.h:
+ * ace/DLL_Manager.h:
+ * ace/FILE.h:
+ * ace/Free_List.h:
+ * ace/INET_Addr.h:
+ * ace/IO_SAP.h:
+ * ace/Local_Memory_Pool.h:
+ * ace/Log_Record.h:
+ * ace/Malloc_Base.h:
+ * ace/Map_Manager.h:
+ * ace/Mem_Map.h:
+ * ace/Message_Queue_T.h:
+ * ace/MMAP_Memory_Pool.h:
+ * ace/Pagefile_Memory_Pool.h:
+ * ace/QoS/SOCK_Dgram_Mcast_QoS.h:
+ * ace/Reactor_Impl.h:
+ * ace/Registry.h:
+ * ace/Remote_Tokens.h:
+ * ace/RW_Process_Mutex.h:
+ * ace/Sbrk_Memory_Pool.h:
+ * ace/Service_Gestalt.h:
+ * ace/Shared_Memory_Pool.h:
+ * ace/Signal.h:
+ * ace/SOCK_Dgram.h:
+ * ace/SPIPE_Connector.h:
+ * ace/SPIPE_Stream.h:
+ * ace/Timer_Heap_T.h:
+ * ace/Timer_Wheel_T.h:
+ * ace/Unbounded_Set.h:
+ * ace/WFMO_Reactor.h:
+ Doxygen improvements
+
Thu May 24 05:43:03 UTC 2007 Olli Savia <ops@iki.fi>
* configure.ac:
@@ -6,11 +44,11 @@ Thu May 24 05:43:03 UTC 2007 Olli Savia <ops@iki.fi>
Thu May 24 05:13:46 UTC 2007 Abdullah Sowayan <abdullah.sowayan@lmco.com>
* ace/Pipe.cpp:
-
+
Wed May 23 22:00:32 UTC 2007 Steve Huston <shuston...>
Due the changelog above, changed the type of index in the for
loop from size_t to int to eliminate compiler warnings about
- signed/unsigned comparison.
+ signed/unsigned comparison.
Thu May 24 04:58:14 UTC 2007 Abdullah Sowayan <abdullah.sowayan@lmco.com>
diff --git a/ACE/ace/ATM_Addr.h b/ACE/ace/ATM_Addr.h
index e8ee48d159c..34cbfd876a6 100644
--- a/ACE/ace/ATM_Addr.h
+++ b/ACE/ace/ATM_Addr.h
@@ -130,8 +130,8 @@ public:
/**
* Return the character representation of the ATM address (e.g.,
* "47.0005.80.ffe100.0000.f20f.2200.0020480694f9.00") storing it in
- * the <addr> (which is assumed to be <addrlen> bytes long). This
- * version is reentrant. Returns -1 if the <addrlen> of the <addr>
+ * the @a addr (which is assumed to be <addrlen> bytes long). This
+ * version is reentrant. Returns -1 if the <addrlen> of the @a addr
* is too small, else 0.
*/
virtual int addr_to_string (ACE_TCHAR addr[],
diff --git a/ACE/ace/Array_Base.h b/ACE/ace/Array_Base.h
index 2f759aba853..210bab6d46d 100644
--- a/ACE/ace/Array_Base.h
+++ b/ACE/ace/Array_Base.h
@@ -94,21 +94,21 @@ public:
// = Set/get methods.
- /// Set item in the array at location <slot>. Doesn't
+ /// Set item in the array at location @a slot. Doesn't
/// perform range checking.
T & operator[] (size_type slot);
- /// Get item in the array at location <slot>. Doesn't
+ /// Get item in the array at location @a slot. Doesn't
/// perform range checking.
T const & operator[] (size_type slot) const;
- /// Set an item in the array at location <slot>. Returns
- /// -1 if <slot> is not in range, else returns 0.
+ /// Set an item in the array at location @a slot. Returns
+ /// -1 if @a slot is not in range, else returns 0.
int set (T const & new_item, size_type slot);
/**
- * Get an item in the array at location <slot>. Returns -1 if
- * <slot> is not in range, else returns 0. Note that this function
+ * Get an item in the array at location @a slot. Returns -1 if
+ * @a slot is not in range, else returns 0. Note that this function
* copies the item. If you want to avoid the copy, you can use
* the const operator [], but then you'll be responsible for range checking.
*/
@@ -146,7 +146,7 @@ public:
const_iterator begin (void) const;
const_iterator end (void) const;
//@}
-
+
/**
* @name Reverse Iterator Accessors
*
@@ -158,14 +158,14 @@ public:
const_reverse_iterator rbegin (void) const;
const_reverse_iterator rend (void) const;
//@}
-
+
/// Swap the contents of this array with the given @a array in
/// an exception-safe manner.
void swap (ACE_Array_Base<T> & array);
protected:
- /// Returns 1 if <slot> is within range, i.e., 0 >= <slot> <
+ /// Returns 1 if @a slot is within range, i.e., 0 >= @a slot <
/// <cur_size_>, else returns 0.
bool in_range (size_type slot) const;
diff --git a/ACE/ace/Barrier.h b/ACE/ace/Barrier.h
index 43944af9c9f..00e22ec19f5 100644
--- a/ACE/ace/Barrier.h
+++ b/ACE/ace/Barrier.h
@@ -168,7 +168,7 @@ private:
class ACE_Export ACE_Process_Barrier : public ACE_Barrier
{
public:
- /// Create a Process_Barrier, passing in the optional <name>.
+ /// Create a Process_Barrier, passing in the optional @a name.
ACE_Process_Barrier (unsigned int count, const ACE_TCHAR *name = 0);
/// Dump the state of an object.
diff --git a/ACE/ace/Based_Pointer_Repository.h b/ACE/ace/Based_Pointer_Repository.h
index 3f34819b371..f7d7ac64125 100644
--- a/ACE/ace/Based_Pointer_Repository.h
+++ b/ACE/ace/Based_Pointer_Repository.h
@@ -61,7 +61,7 @@ public:
int bind (void *addr,
size_t size);
- /// Unbind from the repository the <base_addr> that <addr> is
+ /// Unbind from the repository the <base_addr> that @a addr is
/// contained within.
int unbind (void *addr);
diff --git a/ACE/ace/Configuration.h b/ACE/ace/Configuration.h
index bba0cf4ae6a..c41ec07274a 100644
--- a/ACE/ace/Configuration.h
+++ b/ACE/ace/Configuration.h
@@ -405,7 +405,7 @@ protected:
(const ACE_Configuration_Section_Key& key);
/**
- * Tests to see if <name> is valid. <name> must be < 255 characters
+ * Tests to see if @a name is valid. @a 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. The path separator is allowed, except for the first character,
@@ -414,9 +414,9 @@ protected:
int validate_name (const ACE_TCHAR* name, int allow_path = 0);
/**
- * Test to see if <name> is valid. The default value for a key can be
- * unnamed, which means either <name> is == 0 or <name> == '\0` is
- * valid. Otherwise, it calls validate_name() to test <name> for the
+ * Test to see if @a name is valid. The default value for a key can be
+ * unnamed, which means either @a name is == 0 or @a name == '\0` is
+ * valid. Otherwise, it calls validate_name() to test @a name for the
* same rules that apply to keys.
*/
int validate_value_name (const ACE_TCHAR* name);
@@ -848,7 +848,7 @@ public:
const ACE_TCHAR* name,
VALUETYPE& type);
- /// Removes the the value <name> from @a key. returns non zero on error
+ /// Removes the the value @a name from @a key. returns non zero on error
virtual int remove_value (const ACE_Configuration_Section_Key& key,
const ACE_TCHAR* name);
diff --git a/ACE/ace/DLL_Manager.h b/ACE/ace/DLL_Manager.h
index 147c5802197..6c9db0c529d 100644
--- a/ACE/ace/DLL_Manager.h
+++ b/ACE/ace/DLL_Manager.h
@@ -255,7 +255,7 @@ private:
/// Unload strategy.
u_long unload_policy_;
- /// Pointer to a process-wide <ACE_DLL_Manager>.
+ /// Pointer to a process-wide ACE_DLL_Manager.
static ACE_DLL_Manager *instance_;
#if defined (ACE_MT_SAFE) && (ACE_MT_SAFE != 0)
diff --git a/ACE/ace/FILE.h b/ACE/ace/FILE.h
index 4a6f23c6c08..a2f8932c854 100644
--- a/ACE/ace/FILE.h
+++ b/ACE/ace/FILE.h
@@ -77,7 +77,7 @@ public:
/// Get information on this ACE_FILE.
int get_info (ACE_FILE_Info *finfo);
- /// Get information on this <ACE_FILE>.
+ /// Get information on this ACE_FILE.
int get_info (ACE_FILE_Info &finfo);
/// Set filesize to length byte.
diff --git a/ACE/ace/Free_List.h b/ACE/ace/Free_List.h
index d8bee5f43af..6a21bf11a01 100644
--- a/ACE/ace/Free_List.h
+++ b/ACE/ace/Free_List.h
@@ -51,7 +51,7 @@ public:
/// Returns the current size of the free list.
virtual size_t size (void) = 0;
- /// Resizes the free list to <newsize>.
+ /// Resizes the free list to @a newsize.
virtual void resize (size_t newsize) = 0;
};
diff --git a/ACE/ace/INET_Addr.h b/ACE/ace/INET_Addr.h
index e0fdd8c4001..76672eb265c 100644
--- a/ACE/ace/INET_Addr.h
+++ b/ACE/ace/INET_Addr.h
@@ -160,7 +160,7 @@ public:
const char protocol[] = "tcp");
/**
- * Initializes an ACE_INET_Addr from the <addr>, which can be
+ * Initializes an ACE_INET_Addr from the @a addr, which can be
* "ip-number:port-number" (e.g., "tango.cs.wustl.edu:1234" or
* "128.252.166.57:1234"). If there is no ':' in the <address> it
* is assumed to be a port number, with the IP address being
@@ -290,7 +290,7 @@ public:
/**
* Return the "dotted decimal" Internet address representation of
- * the hostname storing it in the <addr> (which is assumed to be
+ * the hostname storing it in the @a addr (which is assumed to be
* <addr_size> bytes long). This version is reentrant.
*/
const char *get_host_addr (char *addr, int addr_size) const;
diff --git a/ACE/ace/IO_SAP.h b/ACE/ace/IO_SAP.h
index 5e2e00b6e5e..cea8213e177 100644
--- a/ACE/ace/IO_SAP.h
+++ b/ACE/ace/IO_SAP.h
@@ -29,7 +29,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
* @class ACE_IO_SAP
*
* @brief Defines the methods for the base class of the ACE_IO_SAP
- * abstraction, which includes <ACE_FILE> and <ACE_DEV>.
+ * abstraction, which includes ACE_FILE and ACE_DEV.
*/
class ACE_Export ACE_IO_SAP
{
diff --git a/ACE/ace/Local_Memory_Pool.h b/ACE/ace/Local_Memory_Pool.h
index d6862553eb4..0a7abe4912a 100644
--- a/ACE/ace/Local_Memory_Pool.h
+++ b/ACE/ace/Local_Memory_Pool.h
@@ -81,14 +81,14 @@ public:
virtual int sync (void *addr, size_t len, int flags = MS_SYNC);
/**
- * Change the protection of the pages of the mapped region to <prot>
+ * Change the protection of the pages of the mapped region to @a prot
* starting at <this->base_addr_> up to @a len bytes. If @a len == -1
* then change protection of all pages in the mapped region.
*/
virtual int protect (ssize_t len = -1, int prot = PROT_RDWR);
- /// Change the protection of the pages of the mapped region to <prot>
- /// starting at <addr> up to @a len bytes.
+ /// Change the protection of the pages of the mapped region to @a prot
+ /// starting at @a addr up to @a len bytes.
virtual int protect (void *addr, size_t len, int prot = PROT_RDWR);
#if defined (ACE_WIN32)
@@ -101,7 +101,7 @@ public:
#endif /* ACE_WIN32 */
/**
- * Try to extend the virtual address space so that <addr> is now
+ * Try to extend the virtual address space so that @a addr is now
* covered by the address mapping. Always returns 0 since we can't
* remap a local memory pool.
*/
diff --git a/ACE/ace/Log_Record.h b/ACE/ace/Log_Record.h
index 4b8aa552a62..ec36a5d7057 100644
--- a/ACE/ace/Log_Record.h
+++ b/ACE/ace/Log_Record.h
@@ -100,7 +100,7 @@ public:
*/
static const ACE_TCHAR *priority_name (ACE_Log_Priority p);
- // IMPORTANT: <name> must be a statically allocated const ACE_TCHAR*
+ // IMPORTANT: @a name must be a statically allocated const ACE_TCHAR*
static void priority_name (ACE_Log_Priority p,
const ACE_TCHAR *name);
@@ -136,7 +136,7 @@ public:
/// power of 2, as defined by the enums in <ACE_Log_Priority>).
void priority (u_long num);
- /// Get the total length of the <Log_Record>, which includes the
+ /// Get the total length of the <Log_Record>, which includes the
/// size of the various data member fields.
long length (void) const;
diff --git a/ACE/ace/MMAP_Memory_Pool.h b/ACE/ace/MMAP_Memory_Pool.h
index aac103f1728..ede22814183 100644
--- a/ACE/ace/MMAP_Memory_Pool.h
+++ b/ACE/ace/MMAP_Memory_Pool.h
@@ -173,14 +173,14 @@ public:
virtual int sync (void *addr, size_t len, int flags = MS_SYNC);
/**
- * Change the protection of the pages of the mapped region to <prot>
+ * Change the protection of the pages of the mapped region to @a prot
* starting at <this->base_addr_> up to @a len bytes. If @a len == -1
* then change protection of all pages in the mapped region.
*/
virtual int protect (size_t len, int prot = PROT_RDWR);
/**
- * Change the protection of all the pages of the mapped region to <prot>
+ * Change the protection of all the pages of the mapped region to @a prot
* starting at <this->base_addr_>.
*/
virtual int protect (int prot = PROT_RDWR);
diff --git a/ACE/ace/Malloc_Base.h b/ACE/ace/Malloc_Base.h
index eb992bdd26a..e9e15923737 100644
--- a/ACE/ace/Malloc_Base.h
+++ b/ACE/ace/Malloc_Base.h
@@ -61,14 +61,14 @@ public:
/// Virtual destructor
virtual ~ACE_Allocator (void);
- /// Allocate <nbytes>, but don't give them any initial value.
+ /// Allocate @a nbytes, but don't give them any initial value.
virtual void *malloc (size_type nbytes) = 0;
- /// Allocate <nbytes>, giving them <initial_value>.
+ /// Allocate @a nbytes, giving them @a initial_value.
virtual void *calloc (size_type nbytes, char initial_value = '\0') = 0;
- /// Allocate <n_elem> each of size <elem_size>, giving them
- /// <initial_value>.
+ /// Allocate <n_elem> each of size @a elem_size, giving them
+ /// @a initial_value.
virtual void *calloc (size_type n_elem,
size_type elem_size,
char initial_value = '\0') = 0;
@@ -82,29 +82,29 @@ public:
// = Map manager like functions
/**
- * Associate <name> with <pointer>. If <duplicates> == 0 then do
- * not allow duplicate <name>/<pointer> associations, else if
- * <duplicates> != 0 then allow duplicate <name>/<pointer>
+ * Associate @a name with @a pointer. If @a duplicates == 0 then do
+ * not allow duplicate @a name/@a pointer associations, else if
+ * @a duplicates != 0 then allow duplicate @a name/@a pointer
* assocations. Returns 0 if successfully binds (1) a previously
- * unbound <name> or (2) <duplicates> != 0, returns 1 if trying to
- * bind a previously bound <name> and <duplicates> == 0, else
+ * unbound @a name or (2) @a duplicates != 0, returns 1 if trying to
+ * bind a previously bound @a name and @a duplicates == 0, else
* returns -1 if a resource failure occurs.
*/
virtual int bind (const char *name, void *pointer, int duplicates = 0) = 0;
/**
- * Associate <name> with <pointer>. Does not allow duplicate
- * <name>/<pointer> associations. Returns 0 if successfully binds
- * (1) a previously unbound <name>, 1 if trying to bind a previously
- * bound <name>, or returns -1 if a resource failure occurs. When
- * this call returns <pointer>'s value will always reference the
- * void * that <name> is associated with. Thus, if the caller needs
- * to use <pointer> (e.g., to free it) a copy must be maintained by
+ * Associate @a name with @a pointer. Does not allow duplicate
+ * @a name/@a pointer associations. Returns 0 if successfully binds
+ * (1) a previously unbound @a name, 1 if trying to bind a previously
+ * bound @a name, or returns -1 if a resource failure occurs. When
+ * this call returns @a pointer's value will always reference the
+ * void * that @a name is associated with. Thus, if the caller needs
+ * to use @a pointer (e.g., to free it) a copy must be maintained by
* the caller.
*/
virtual int trybind (const char *name, void *&pointer) = 0;
- /// Locate <name> and pass out parameter via pointer. If found,
+ /// Locate @a name and pass out parameter via pointer. If found,
/// return 0, returns -1 if failure occurs.
virtual int find (const char *name, void *&pointer) = 0;
@@ -134,14 +134,14 @@ public:
virtual int sync (void *addr, size_type len, int flags = MS_SYNC) = 0;
/**
- * Change the protection of the pages of the mapped region to <prot>
+ * Change the protection of the pages of the mapped region to @a prot
* starting at <this->base_addr_> up to @a len bytes. If @a len == -1
* then change protection of all pages in the mapped region.
*/
virtual int protect (ssize_t len = -1, int prot = PROT_RDWR) = 0;
- /// Change the protection of the pages of the mapped region to <prot>
- /// starting at <addr> up to @a len bytes.
+ /// Change the protection of the pages of the mapped region to @a prot
+ /// starting at @a addr up to @a len bytes.
virtual int protect (void *addr, size_type len, int prot = PROT_RDWR) = 0;
#if defined (ACE_HAS_MALLOC_STATS)
diff --git a/ACE/ace/Map_Manager.h b/ACE/ace/Map_Manager.h
index e045f6ccf54..75c2b65f977 100644
--- a/ACE/ace/Map_Manager.h
+++ b/ACE/ace/Map_Manager.h
@@ -350,7 +350,7 @@ protected:
int unbind_and_return_index (const EXT_ID &ext_id,
ACE_UINT32 &slot);
- /// Unbind <slot>.
+ /// Unbind @a slot.
void unbind_slot (ACE_UINT32 slot);
/// Resize the map. Must be called with locks held.
diff --git a/ACE/ace/Mem_Map.h b/ACE/ace/Mem_Map.h
index 157ecf796ac..903583c5512 100644
--- a/ACE/ace/Mem_Map.h
+++ b/ACE/ace/Mem_Map.h
@@ -152,19 +152,19 @@ public:
int sync (void *addr, size_t len, int flags = MS_SYNC);
/**
- * Change the protection of the pages of the mapped region to <prot>
+ * Change the protection of the pages of the mapped region to @a prot
* starting at <base_addr_> up to @a len bytes.
*/
int protect (size_t len, int prot = PROT_RDWR);
/**
- * Change the protection of all the pages of the mapped region to <prot>
+ * Change the protection of all the pages of the mapped region to @a prot
* starting at <base_addr_>.
*/
int protect (int prot = PROT_RDWR);
- /// Change the protection of the pages of the mapped region to <prot>
- /// starting at <addr> up to @a len bytes.
+ /// Change the protection of the pages of the mapped region to @a prot
+ /// starting at @a addr up to @a len bytes.
int protect (void *addr, size_t len, int prot = PROT_RDWR);
/// Close and remove the file from the file system.
diff --git a/ACE/ace/Message_Queue_T.h b/ACE/ace/Message_Queue_T.h
index 912fc565de4..ff6a8b8969c 100644
--- a/ACE/ace/Message_Queue_T.h
+++ b/ACE/ace/Message_Queue_T.h
@@ -1346,7 +1346,7 @@ public:
virtual void notification_strategy (ACE_Notification_Strategy *s);
//@}
- /// Returns a reference to the lock used by the <ACE_Message_Queue_Ex>.
+ /// Returns a reference to the lock used by the ACE_Message_Queue_Ex.
virtual ACE_SYNCH_MUTEX_T &lock (void);
/// Dump the state of an object.
diff --git a/ACE/ace/Pagefile_Memory_Pool.h b/ACE/ace/Pagefile_Memory_Pool.h
index 2571755eca1..a82e5706c3f 100644
--- a/ACE/ace/Pagefile_Memory_Pool.h
+++ b/ACE/ace/Pagefile_Memory_Pool.h
@@ -72,7 +72,7 @@ public:
size_t &rounded_bytes,
int &first_time);
- /// Acquire at least <nbytes> from the memory pool. <rounded_bytes>
+ /// Acquire at least @a nbytes from the memory pool. <rounded_bytes>
/// is the actual number of bytes allocated.
void *acquire (size_t nbytes,
size_t &rounded_bytes);
@@ -88,7 +88,7 @@ public:
virtual int seh_selector (void *);
/**
- * Try to extend the virtual address space so that <addr> is now
+ * Try to extend the virtual address space so that @a addr is now
* covered by the address mapping. The method succeeds and returns
* 0 if the backing store has adequate memory to cover this address.
* Otherwise, it returns -1. This method is typically called by an
diff --git a/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h b/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h
index 1bb5f873a8c..d397bb68e70 100644
--- a/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h
+++ b/ACE/ace/QoS/SOCK_Dgram_Mcast_QoS.h
@@ -81,7 +81,7 @@ public:
// = Data transfer routines.
- /// Send <buffer_count> worth of <buffers> to <addr> using overlapped
+ /// Send <buffer_count> worth of @a buffers to @a addr using overlapped
/// I/O (uses <WSASentTo>). Returns 0 on success.
ssize_t send (const iovec buffers[],
int buffer_count,
diff --git a/ACE/ace/RW_Process_Mutex.h b/ACE/ace/RW_Process_Mutex.h
index 4676d930e31..6242d81f43c 100644
--- a/ACE/ace/RW_Process_Mutex.h
+++ b/ACE/ace/RW_Process_Mutex.h
@@ -43,7 +43,7 @@ class ACE_Export ACE_RW_Process_Mutex
{
public:
/// Create a readers/writer <Process_Mutex>, passing in the optional
- /// <name>, <flags> and <mode> \sa ACE_File_Lock.
+ /// @a name, <flags> and <mode> \sa ACE_File_Lock.
/// If not specified, a name is generated and flags and mode are set
/// to default platform values.
#if defined (ACE_WIN32)
diff --git a/ACE/ace/Reactor_Impl.h b/ACE/ace/Reactor_Impl.h
index 94d022b1dbf..df341bf5f40 100644
--- a/ACE/ace/Reactor_Impl.h
+++ b/ACE/ace/Reactor_Impl.h
@@ -41,7 +41,7 @@ class ACE_Sig_Set;
*
* @internal This class is for ACE internal use only.
*
- * @brief Abstract class for unblocking an <ACE_Reactor_Impl> from its
+ * @brief Abstract class for unblocking an ACE_Reactor_Impl from its
* event loop.
*/
class ACE_Export ACE_Reactor_Notify : public ACE_Event_Handler
diff --git a/ACE/ace/Registry.h b/ACE/ace/Registry.h
index faa4a62098f..e7a882ee357 100644
--- a/ACE/ace/Registry.h
+++ b/ACE/ace/Registry.h
@@ -226,36 +226,36 @@ public:
const Object &object);
/**
- * Insert or update <object> with <name> into @c this context
- * This will not fail if <name> already exists
+ * Insert or update <object> with @a name into @c this context
+ * This will not fail if @a name already exists
* (String version)
*/
int bind (const ACE_TString &name,
const Object &object);
- /// Update <object> with <name> in @c this context
+ /// Update <object> with @a name in @c this context
/// (Name version)
int rebind (const Name &name,
const Object &object);
- /// Update <object> with <name> in @c this context
+ /// Update <object> with @a name in @c this context
int rebind (const ACE_TString &name,
const Object &object);
- /// Find <object> with <name> in @c this context
+ /// Find <object> with @a name in @c this context
/// (Name version)
int resolve (const Name &name,
Object &object);
- /// Find <object> with <name> in @c this context
+ /// Find <object> with @a name in @c this context
int resolve (const ACE_TString &name,
Object &object);
- /// Delete object with <name> in @c this context
+ /// Delete object with @a name in @c this context
/// (Name version)
int unbind (const Name &name);
- /// Delete object with <name> in @c this context
+ /// Delete object with @a name in @c this context
int unbind (const ACE_TString &name);
@@ -265,8 +265,8 @@ public:
int new_context (Naming_Context &naming_context);
/**
- * Insert <naming_context> with <name> relative to @c this context
- * This will fail if <name> already exists
+ * Insert <naming_context> with @a name relative to @c this context
+ * This will fail if @a name already exists
* (Name version)
*/
int bind_new_context (const Name &name,
@@ -275,8 +275,8 @@ public:
u_long security_access = KEY_ALL_ACCESS,
LPSECURITY_ATTRIBUTES security_attributes = 0);
- /// Insert <naming_context> with <name> relative to @c this context
- /// This will fail if <name> already exists
+ /// Insert <naming_context> with @a name relative to @c this context
+ /// This will fail if @a name already exists
int bind_new_context (const ACE_TString &name,
Naming_Context &naming_context,
u_long persistence = REG_OPTION_NON_VOLATILE,
@@ -284,8 +284,8 @@ public:
LPSECURITY_ATTRIBUTES security_attributes = 0);
/**
- * Insert or update <naming_context> with <name> relative to @c this context
- * This will not fail if <name> already exists
+ * Insert or update <naming_context> with @a name relative to @c this context
+ * This will not fail if @a name already exists
* (Name version)
*/
int bind_context (const Name &name,
@@ -294,39 +294,39 @@ public:
u_long security_access = KEY_ALL_ACCESS,
LPSECURITY_ATTRIBUTES security_attributes = 0);
- /// Insert or update <naming_context> with <name> relative to @c this context
- /// This will not fail if <name> already exists
+ /// Insert or update <naming_context> with @a name relative to @c this context
+ /// This will not fail if @a name already exists
int bind_context (const ACE_TString &name,
/* const */ Naming_Context &naming_context,
u_long persistence = REG_OPTION_NON_VOLATILE,
u_long security_access = KEY_ALL_ACCESS,
LPSECURITY_ATTRIBUTES security_attributes = 0);
- /// Rename <naming_context> to <name>
+ /// Rename <naming_context> to @a name
/// (Name version)
int rebind_context (const Name &name,
/* const */ Naming_Context &naming_context);
- /// Rename <naming_context> to <name>
+ /// Rename <naming_context> to @a name
int rebind_context (const ACE_TString &name,
/* const */ Naming_Context &naming_context);
- /// Find <naming_context> with <name> in @c this context
+ /// Find <naming_context> with @a name in @c this context
/// (Name version)
int resolve_context (const Name &name,
Naming_Context &naming_context,
u_long security_access = KEY_ALL_ACCESS);
- /// Find <naming_context> with <name> in @c this context
+ /// Find <naming_context> with @a name in @c this context
int resolve_context (const ACE_TString &name,
Naming_Context &naming_context,
u_long security_access = KEY_ALL_ACCESS);
- /// Remove naming_context with <name> from @c this context
+ /// Remove naming_context with @a name from @c this context
/// (Name version)
int unbind_context (const Name &name);
- /// Remove naming_context with <name> from @c this context
+ /// Remove naming_context with @a name from @c this context
int unbind_context (const ACE_TString &name);
/// Same as <unbind_context> with @c this as naming_context
diff --git a/ACE/ace/Remote_Tokens.h b/ACE/ace/Remote_Tokens.h
index e9c9625aa2d..288d0ca454f 100644
--- a/ACE/ace/Remote_Tokens.h
+++ b/ACE/ace/Remote_Tokens.h
@@ -55,7 +55,7 @@ public:
virtual ~ACE_Remote_Token_Proxy (void);
/**
- * Same as Token_Proxy. <name> is the string uniquely identifying
+ * Same as Token_Proxy. @a name is the string uniquely identifying
* the token. <ignore_deadlock> can be 1 to disable deadlock
* notifications. <debug> prints debug messages.
*/
diff --git a/ACE/ace/SOCK_Dgram.h b/ACE/ace/SOCK_Dgram.h
index 23dc687eba1..4f95edea6d2 100644
--- a/ACE/ace/SOCK_Dgram.h
+++ b/ACE/ace/SOCK_Dgram.h
@@ -154,7 +154,7 @@ public:
int flags,
const ACE_Time_Value *timeout) const;
- /// Send <buffer_count> worth of <buffers> to <addr> using overlapped
+ /// Send <buffer_count> worth of @a buffers to @a addr using overlapped
/// I/O (uses <WSASendTo>). Returns 0 on success.
ssize_t send (const iovec buffers[],
int buffer_count,
@@ -164,7 +164,7 @@ public:
ACE_OVERLAPPED *overlapped,
ACE_OVERLAPPED_COMPLETION_FUNC func) const;
- /// Recv <buffer_count> worth of <buffers> from <addr> using
+ /// Recv <buffer_count> worth of @a buffers from @a addr using
/// overlapped I/O (uses <WSARecvFrom>). Returns 0 on success.
ssize_t recv (iovec buffers[],
int buffer_count,
diff --git a/ACE/ace/SPIPE_Connector.h b/ACE/ace/SPIPE_Connector.h
index a0e1f36a318..395d14bf241 100644
--- a/ACE/ace/SPIPE_Connector.h
+++ b/ACE/ace/SPIPE_Connector.h
@@ -27,7 +27,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class ACE_SPIPE_Connector
*
- * @brief Defines an active connection factory for <ACE_SPIPE_Stream>.
+ * @brief Defines an active connection factory for ACE_SPIPE_Stream.
* On Windows this is mapped to Named Pipes, whereas on UNIX it is
* mapped to STREAM pipes.
*/
diff --git a/ACE/ace/SPIPE_Stream.h b/ACE/ace/SPIPE_Stream.h
index 7e4c90735f4..9293224b7ed 100644
--- a/ACE/ace/SPIPE_Stream.h
+++ b/ACE/ace/SPIPE_Stream.h
@@ -29,7 +29,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class ACE_SPIPE_Stream
*
- * @brief Defines the methods in the <ACE_SPIPE_Stream> abstraction.
+ * @brief Defines the methods in the ACE_SPIPE_Stream abstraction.
*
* @a buf is the buffer to write from or receive into.
* @a len is the number of bytes to transfer.
diff --git a/ACE/ace/Sbrk_Memory_Pool.h b/ACE/ace/Sbrk_Memory_Pool.h
index c98f3a7ab64..3442d5719cf 100644
--- a/ACE/ace/Sbrk_Memory_Pool.h
+++ b/ACE/ace/Sbrk_Memory_Pool.h
@@ -84,7 +84,7 @@ public:
virtual int sync (void *addr, size_t len, int flags = MS_SYNC);
/**
- * Change the protection of the pages of the mapped region to <prot>
+ * Change the protection of the pages of the mapped region to @a prot
* starting at @c this->base_addr_ up to @a len bytes. If @a len == -1
* then change protection of all pages in the mapped region.
*/
diff --git a/ACE/ace/Service_Gestalt.h b/ACE/ace/Service_Gestalt.h
index d5ce83868c1..5cf3bfb5d88 100644
--- a/ACE/ace/Service_Gestalt.h
+++ b/ACE/ace/Service_Gestalt.h
@@ -202,11 +202,11 @@ public:
int process_file (const ACE_TCHAR file[]);
/**
- * Locate an entry with <name> in the table. If <ignore_suspended>
+ * Locate an entry with @a name in the table. If <ignore_suspended>
* is set then only consider services marked as resumed. If the
* caller wants the located entry, pass back a pointer to the
- * located entry via <srp>. If <name> is not found, -1 is returned.
- * If <name> is found, but it is suspended and the caller wants to
+ * located entry via <srp>. If @a name is not found, -1 is returned.
+ * If @a name is found, but it is suspended and the caller wants to
* ignore suspended services a -2 is returned.
*/
int find (const ACE_TCHAR name[],
diff --git a/ACE/ace/Shared_Memory_Pool.h b/ACE/ace/Shared_Memory_Pool.h
index dfc5786b57f..bb694edceb0 100644
--- a/ACE/ace/Shared_Memory_Pool.h
+++ b/ACE/ace/Shared_Memory_Pool.h
@@ -115,14 +115,14 @@ public:
virtual int sync (void *addr, size_t len, int flags = MS_SYNC);
/**
- * Change the protection of the pages of the mapped region to <prot>
+ * Change the protection of the pages of the mapped region to @a prot
* starting at @c this->base_addr_ up to @a len bytes. If @a len == -1
* then change protection of all pages in the mapped region.
*/
virtual int protect (ssize_t len = -1, int prot = PROT_RDWR);
- /// Change the protection of the pages of the mapped region to <prot>
- /// starting at <addr> up to @a len bytes.
+ /// Change the protection of the pages of the mapped region to @a prot
+ /// starting at @a addr up to @a len bytes.
virtual int protect (void *addr, size_t len, int prot = PROT_RDWR);
/// Return the base address of this memory pool, 0 if base_addr
diff --git a/ACE/ace/Signal.h b/ACE/ace/Signal.h
index 952ac517b59..b93b8c0c39c 100644
--- a/ACE/ace/Signal.h
+++ b/ACE/ace/Signal.h
@@ -66,13 +66,13 @@ public:
/// Create a set that includes all signals defined by the system.
int fill_set (void);
- /// Adds the individual signal specified by <signo> to the set.
+ /// Adds the individual signal specified by @a signo to the set.
int sig_add (int signo);
- /// Deletes the individual signal specified by <signo> from the set.
+ /// Deletes the individual signal specified by @a signo from the set.
int sig_del (int signo);
- /// Checks whether the signal specified by <signo> is in the set.
+ /// Checks whether the signal specified by @a signo is in the set.
int is_member (int signo) const;
/// Returns a pointer to the underlying <sigset_t>.
@@ -104,21 +104,21 @@ public:
/// Default constructor. Initializes everything to 0.
ACE_Sig_Action (void);
- /// Assigns the various fields of a <sigaction> struct but doesn't
- /// register for signal handling via the <sigaction> function.
+ /// Assigns the various fields of a @c sigaction struct but doesn't
+ /// register for signal handling via the @c sigaction function.
ACE_Sig_Action (ACE_SignalHandler handler,
sigset_t *sigmask = 0,
int flags = 0);
- /// Assigns the various fields of a <sigaction> struct but doesn't
- /// register for signal handling via the <sigaction> function.
+ /// Assigns the various fields of a @c sigaction struct but doesn't
+ /// register for signal handling via the @c sigaction function.
ACE_Sig_Action (ACE_SignalHandler handler,
const ACE_Sig_Set &sigmask,
int flags = 0);
/**
- * Assigns the various fields of a <sigaction> struct and registers
- * the <handler> to process signal @a signum via the <sigaction>
+ * Assigns the various fields of a @c sigaction struct and registers
+ * the <handler> to process signal @a signum via the @c sigaction
* function.
*/
ACE_Sig_Action (ACE_SignalHandler handler,
@@ -127,8 +127,8 @@ public:
int flags = 0);
/**
- * Assigns the various fields of a <sigaction> struct and registers
- * the <handler> to process signal @a signum via the <sigaction>
+ * Assigns the various fields of a @c sigaction struct and registers
+ * the <handler> to process signal @a signum via the @c sigaction
* function.
*/
ACE_Sig_Action (ACE_SignalHandler handler,
@@ -149,8 +149,8 @@ public:
// that would cause a problem with something else - Bala <bala@cs>
/**
- * Assigns the various fields of a <sigaction> struct and registers
- * the <handler> to process all <signals> via the <sigaction>
+ * Assigns the various fields of a @c sigaction struct and registers
+ * the <handler> to process all @a signalss via the @c sigaction
* function.
*/
ACE_Sig_Action (const ACE_Sig_Set &signalss,
@@ -159,8 +159,8 @@ public:
int flags = 0);
/**
- * Assigns the various fields of a <sigaction> struct and registers
- * the <handler> to process all <signals> via the <sigaction>
+ * Assigns the various fields of a @c sigaction struct and registers
+ * the <handler> to process all @a signalss via the @c sigaction
* function.
*/
ACE_Sig_Action (const ACE_Sig_Set &signalss,
@@ -176,7 +176,7 @@ public:
// = Signal action management.
/// Register @c this as the current disposition and store old
- /// disposition into <oaction> if it is non-NULL.
+ /// disposition into @a oaction if it is non-NULL.
int register_action (int signum,
ACE_Sig_Action *oaction = 0);
diff --git a/ACE/ace/Timer_Heap_T.h b/ACE/ace/Timer_Heap_T.h
index 632c92ddb77..2191588a555 100644
--- a/ACE/ace/Timer_Heap_T.h
+++ b/ACE/ace/Timer_Heap_T.h
@@ -32,7 +32,7 @@ class ACE_Timer_Heap_T;
/**
* @class ACE_Timer_Heap_Iterator_T
*
- * @brief Iterates over an <ACE_Timer_Heap_T>.
+ * @brief Iterates over an ACE_Timer_Heap_T.
*
* This is a generic iterator that can be used to visit every
* node of a timer queue. Be aware that it doesn't transverse
@@ -219,7 +219,7 @@ protected:
virtual void free_node (ACE_Timer_Node_T<TYPE> *);
private:
- /// Remove and return the <slot>th ACE_Timer_Node and restore the
+ /// Remove and return the @a slotth ACE_Timer_Node and restore the
/// heap property.
ACE_Timer_Node_T<TYPE> *remove (size_t slot);
@@ -233,18 +233,18 @@ private:
*/
void grow_heap (void);
- /// Restore the heap property, starting at <slot>.
+ /// Restore the heap property, starting at @a slot.
void reheap_up (ACE_Timer_Node_T<TYPE> *new_node,
size_t slot,
size_t parent);
- /// Restore the heap property, starting at <slot>.
+ /// Restore the heap property, starting at @a slot.
void reheap_down (ACE_Timer_Node_T<TYPE> *moved_node,
size_t slot,
size_t child);
- /// Copy <moved_node> into the <slot> slot of <heap_> and move
- /// <slot> into the corresponding slot in the <timer_id_> array.
+ /// Copy <moved_node> into the @a slot slot of <heap_> and move
+ /// @a slot into the corresponding slot in the <timer_id_> array.
void copy (size_t slot, ACE_Timer_Node_T<TYPE> *moved_node);
/**
diff --git a/ACE/ace/Timer_Wheel_T.h b/ACE/ace/Timer_Wheel_T.h
index 984ad6d8bb7..6a93094df38 100644
--- a/ACE/ace/Timer_Wheel_T.h
+++ b/ACE/ace/Timer_Wheel_T.h
@@ -29,7 +29,7 @@ class ACE_Timer_Wheel_T;
/**
* @class ACE_Timer_Wheel_Iterator_T
*
- * @brief Iterates over an <ACE_Timer_Wheel>.
+ * @brief Iterates over an ACE_Timer_Wheel.
*
* This is a generic iterator that can be used to visit every
* node of a timer queue. Be aware that it doesn't traverse
@@ -117,7 +117,7 @@ public:
/// True if queue is empty, else false.
virtual int is_empty (void) const;
- /// Returns the time of the earlier node in the <ACE_Timer_Wheel>.
+ /// Returns the time of the earlier node in the ACE_Timer_Wheel.
/// Must be called on a non-empty queue.
virtual const ACE_Time_Value& earliest_time (void) const;
diff --git a/ACE/ace/Unbounded_Set.h b/ACE/ace/Unbounded_Set.h
index 46b0fcf6a73..610ae1733ff 100644
--- a/ACE/ace/Unbounded_Set.h
+++ b/ACE/ace/Unbounded_Set.h
@@ -272,7 +272,7 @@ public:
/// Dump the state of an object.
void dump (void) const;
- /// Reset the <ACE_Unbounded_Set> to be empty.
+ /// Reset the ACE_Unbounded_Set to be empty.
/**
* Delete the nodes of the set.
*/
diff --git a/ACE/ace/WFMO_Reactor.h b/ACE/ace/WFMO_Reactor.h
index 4700720df81..fa516c6644d 100644
--- a/ACE/ace/WFMO_Reactor.h
+++ b/ACE/ace/WFMO_Reactor.h
@@ -358,7 +358,7 @@ public:
/// Make changes to the handle set
virtual int make_changes (void);
- /// Check to see if <slot> has been scheduled for deletion
+ /// Check to see if @a slot has been scheduled for deletion
int scheduled_for_deletion (size_t slot) const;
/**
@@ -399,15 +399,15 @@ public:
/// current_suspended_info_ from to_be_added_info_
int make_changes_in_to_be_added_infos (void);
- /// Removes the ACE_Event_Handler at <slot> from the table.
+ /// Removes the ACE_Event_Handler at @a slot from the table.
int remove_handler_i (size_t slot,
ACE_Reactor_Mask mask);
- /// Removes the ACE_Event_Handler at <slot> from the table.
+ /// Removes the ACE_Event_Handler at @a slot from the table.
int remove_suspended_handler_i (size_t slot,
ACE_Reactor_Mask mask);
- /// Removes the ACE_Event_Handler at <slot> from the table.
+ /// Removes the ACE_Event_Handler at @a slot from the table.
int remove_to_be_added_handler_i (size_t slot,
ACE_Reactor_Mask to_be_removed_masks);
@@ -1215,7 +1215,7 @@ protected:
virtual int safe_dispatch (DWORD wait_status);
/**
- * Dispatches any active handles from handles_[<slot>] to
+ * Dispatches any active handles from handles_[@a slot] to
* handles_[active_handles_] using <WaitForMultipleObjects> to poll
* through our handle set looking for active handles.
*/