From: Kefu Chai <kchai@redhat.com>
Date: Thu, 14 May 2015 10:51:22 +0000 (+0800)
Subject: doc: use @name to define a group, not @group
X-Git-Tag: v9.0.2~159^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=f59d6e1269a687270443371fae826bd1c817ed09;p=ceph.git

doc: use @name to define a group, not @group

we are able to output a specified group using the directive
of `doxygengroup` in breathe. this directive prints out the
description of the group. but it's not realistic to enumerate
all groups defined in source code in the rst files. but the
doxygen command @name also helps to group functions together.
the downside of this approach is that we can not add more
items to a group later on. but it should be fine with us,
since in our case, all the grouped items are living in a single
header file.

Fixes: #9442
Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/src/include/rados/librados.h b/src/include/rados/librados.h
index 877368f39b6..8d8d11b4ba0 100644
--- a/src/include/rados/librados.h
+++ b/src/include/rados/librados.h
@@ -88,7 +88,7 @@ enum {
 #endif
 
 /**
- * @defgroup librados_h_xattr_comp xattr comparison operations
+ * @name xattr comparison operations
  * Operators for comparing xattrs on objects, and aborting the
  * rados_read_op or rados_write_op transaction if the comparison
  * fails.
@@ -106,7 +106,7 @@ enum {
 /** @} */
 
 /**
- * @defgroup librados_h_operation_flags Operation Flags
+ * @name Operation Flags
  * Flags for rados_read_op_opeprate(), rados_write_op_operate(),
  * rados_aio_read_op_operate(), and rados_aio_write_op_operate().
  * See librados.hpp for details.
@@ -306,7 +306,7 @@ typedef void *rados_read_op_t;
 CEPH_RADOS_API void rados_version(int *major, int *minor, int *extra);
 
 /**
- * @defgroup librados_h_init Setup and Teardown
+ * @name Setup and Teardown
  * These are the first and last functions to that should be called
  * when using librados.
  *
@@ -407,7 +407,7 @@ CEPH_RADOS_API void rados_shutdown(rados_t cluster);
 /** @} init */
 
 /**
- * @defgroup librados_h_config Configuration
+ * @name Configuration
  * These functions read and update Ceph configuration for a cluster
  * handle. Any configuration changes must be done before connecting to
  * the cluster.
@@ -563,7 +563,7 @@ CEPH_RADOS_API int rados_cluster_fsid(rados_t cluster, char *buf, size_t len);
 CEPH_RADOS_API int rados_wait_for_latest_osdmap(rados_t cluster);
 
 /**
- * @defgroup librados_h_pools Pools
+ * @name Pools
  *
  * RADOS pools are separate namespaces for objects. Pools may have
  * different crush rules associated with them, so they could have
@@ -830,7 +830,7 @@ CEPH_RADOS_API int rados_ioctx_get_pool_name(rados_ioctx_t io, char *buf,
 /** @} pools */
 
 /**
- * @defgroup librados_h_obj_loc Object Locators
+ * @name Object Locators
  *
  * @{
  */
@@ -869,7 +869,7 @@ CEPH_RADOS_API void rados_ioctx_set_namespace(rados_ioctx_t io,
 /** @} obj_loc */
 
 /**
- * @defgroup librados_h_list_nobj New Listing Objects
+ * @name New Listing Objects
  * @{
  */
 /**
@@ -930,7 +930,7 @@ CEPH_RADOS_API void rados_nobjects_list_close(rados_list_ctx_t ctx);
 /** @} New Listing Objects */
 
 /**
- * @defgroup librados_h_list_obj Deprecated Listing Objects
+ * @name Deprecated Listing Objects
  *
  * Older listing objects interface.  Please use the new interface.
  * @{
@@ -967,7 +967,7 @@ CEPH_RADOS_API void rados_objects_list_close(rados_list_ctx_t ctx);
 /** @} Listing Objects */
 
 /**
- * @defgroup librados_h_snaps Snapshots
+ * @name Snapshots
  *
  * RADOS snapshots are based upon sequence numbers that form a
  * snapshot context. They are pool-specific. The snapshot context
@@ -1162,7 +1162,7 @@ CEPH_RADOS_API int rados_ioctx_snap_get_stamp(rados_ioctx_t io, rados_snap_t id,
 /** @} Snapshots */
 
 /**
- * @defgroup librados_h_synch_io Synchronous I/O
+ * @name Synchronous I/O
  * Writes are replicated to a number of OSDs based on the
  * configuration of the pool they are in. These write functions block
  * until data is in memory on all replicas of the object they're
@@ -1294,7 +1294,7 @@ CEPH_RADOS_API int rados_trunc(rados_ioctx_t io, const char *oid,
                                uint64_t size);
 
 /**
- * @defgroup librados_h_xattrs Xattrs
+ * @name Xattrs
  * Extended attributes are stored as extended attributes on the files
  * representing an object on the OSDs. Thus, they have the same
  * limitations as the underlying filesystem. On ext4, this means that
@@ -1550,7 +1550,7 @@ CEPH_RADOS_API int rados_exec(rados_ioctx_t io, const char *oid,
 /** @} Synchronous I/O */
 
 /**
- * @defgroup librados_h_asynch_io Asynchronous I/O
+ * @name Asynchronous I/O
  * Read and write to objects without blocking.
  *
  * @{
@@ -1866,7 +1866,7 @@ CEPH_RADOS_API int rados_aio_cancel(rados_ioctx_t io,
 /** @} Asynchronous I/O */
 
 /**
- * @defgroup librados_h_watch_notify Watch/Notify
+ * @name Watch/Notify
  *
  * Watch/notify is a protocol to help communicate among clients. It
  * can be used to sychronize client state. All that's needed is a
@@ -2133,7 +2133,7 @@ CEPH_RADOS_API int rados_watch_flush(rados_t cluster);
 /** @} Watch/Notify */
 
 /**
- * @defgroup librados_h_hints Hints
+ * @name Hints
  *
  * @{
  */
@@ -2158,7 +2158,7 @@ CEPH_RADOS_API int rados_set_alloc_hint(rados_ioctx_t io, const char *o,
 /** @} Hints */
 
 /**
- * @defgroup librados_h_obj_op Object Operations
+ * @name Object Operations
  *
  * A single rados operation can do multiple operations on one object
  * atomicly. The whole operation will suceed or fail, and no partial
@@ -2805,7 +2805,7 @@ CEPH_RADOS_API int rados_blacklist_add(rados_t cluster,
 				       uint32_t expire_seconds);
 
 /**
- * @defgroup librados_h_commands Mon/OSD/PG Commands
+ * @name Mon/OSD/PG Commands
  *
  * These interfaces send commands relating to the monitor, OSD, or PGs.
  *