Whamcloud - gitweb
b=22470 Put header file contents into a doxygen group.
authorMark Burton <[mailto:markb@ordern.com]>
Thu, 25 Mar 2010 17:22:03 +0000 (10:22 -0700)
committerRobert Read <rread@sun.com>
Thu, 25 Mar 2010 17:22:03 +0000 (10:22 -0700)
i=rread
Signed-off-by: Mark Burton <markb@ordern.com>
29 files changed:
lustre/include/liblustre.h
lustre/include/lustre/libiam.h
lustre/include/lustre/liblustreapi.h
lustre/include/lustre/lustre_user.h
lustre/include/lustre_capa.h
lustre/include/lustre_cfg.h
lustre/include/lustre_debug.h
lustre/include/lustre_disk.h
lustre/include/lustre_dlm.h
lustre/include/lustre_eacl.h
lustre/include/lustre_export.h
lustre/include/lustre_fid.h
lustre/include/lustre_fld.h
lustre/include/lustre_ha.h
lustre/include/lustre_handles.h
lustre/include/lustre_idmap.h
lustre/include/lustre_import.h
lustre/include/lustre_lib.h
lustre/include/lustre_lite.h
lustre/include/lustre_log.h
lustre/include/lustre_mdc.h
lustre/include/lustre_mds.h
lustre/include/lustre_mdt.h
lustre/include/lustre_net.h
lustre/include/lustre_param.h
lustre/include/lustre_quota.h
lustre/include/lustre_req_layout.h
lustre/include/lustre_sec.h
lustre/include/lustre_ucache.h

index b18deb8..3198055 100644 (file)
 #ifndef LIBLUSTRE_H__
 #define LIBLUSTRE_H__
 
+/** \defgroup liblustre liblustre
+ *
+ * @{
+ */
+
 #ifdef __KERNEL__
 #error Kernel files should not #include <liblustre.h>
 #endif
@@ -517,4 +522,6 @@ static inline void set_fs(mm_segment_t seg)
 #include <lustre_export.h>
 #include <lustre_net.h>
 
+/** @} liblustre */
+
 #endif
index 827b189..bac2d10 100644 (file)
 #ifndef __IAM_ULIB_H__
 #define __IAM_ULIB_H__
 
+/** \defgroup libiam libiam
+ *
+ * @{
+ */
+
 
 #define DX_FMT_NAME_LEN 16
 
@@ -137,5 +142,6 @@ int iam_it_stop(int fd, struct iam_uapi_info *ua,
  */
 int iam_polymorph(char *filename, unsigned long mode);
 
+/** @} libiam */
 
 #endif
index a272031..a096f43 100644 (file)
 #ifndef _LIBLUSTREAPI_H_
 #define _LIBLUSTREAPI_H_
 
+/** \defgroup llapi llapi
+ *
+ * @{
+ */
+
 #include <lustre/lustre_user.h>
 
 /* Initially allocate for these many OSTs, realloc if needed */
@@ -223,6 +228,8 @@ extern int llapi_copytool_recv(void *priv, struct hsm_action_list **hal,
                                int *msgsize);
 extern int llapi_copytool_free(struct hsm_action_list **hal);
 
+/** @} llapi */
+
 #endif
 
 
index 18dce74..8da187d 100644 (file)
 #ifndef _LUSTRE_USER_H
 #define _LUSTRE_USER_H
 
+/** \defgroup lustreuser lustreuser
+ *
+ * @{
+ */
+
 #include <lustre/ll_fiemap.h>
 #if defined(__linux__)
 #include <linux/lustre_user.h>
@@ -593,5 +598,6 @@ static __inline__ struct hsm_action_item * hai_next(struct hsm_action_item *hai)
                                           cfs_size_round(hai->hai_len));
 }
 
+/** @} lustreuser */
 
 #endif /* _LUSTRE_USER_H */
index 3561f8e..73d7b72 100644 (file)
 #ifndef __LINUX_CAPA_H_
 #define __LINUX_CAPA_H_
 
+/** \defgroup capa capa
+ *
+ * @{
+ */
+
 /*
  * capability
  */
@@ -297,4 +302,7 @@ enum {
 };
 
 #define BYPASS_CAPA (struct lustre_capa *)ERR_PTR(-ENOENT)
+
+/** @} capa */
+
 #endif /* __LINUX_CAPA_H_ */
index df002e0..cf3c120 100644 (file)
 #ifndef _LUSTRE_CFG_H
 #define _LUSTRE_CFG_H
 
+/** \defgroup cfg cfg
+ *
+ * @{
+ */
+
 /*
  * 1cf6
  * lcfG
@@ -287,4 +292,6 @@ static inline int lustre_cfg_sanity_check(void *buf, int len)
 
 #define INVALID_UID     (-1)
 
+/** @} cfg */
+
 #endif // _LUSTRE_CFG_H
index 73c22bb..027d757 100644 (file)
 #ifndef _LUSTRE_DEBUG_H
 #define _LUSTRE_DEBUG_H
 
+/** \defgroup debug debug
+ *
+ * @{
+ */
+
 #include <lustre_net.h>
 #include <obd.h>
 
@@ -73,4 +78,7 @@ int dump_req(struct ptlrpc_request *req);
 void dump_lsm(int level, struct lov_stripe_md *lsm);
 int block_debug_setup(void *addr, int len, __u64 off, __u64 id);
 int block_debug_check(char *who, void *addr, int len, __u64 off, __u64 id);
+
+/** @} debug */
+
 #endif
index 0a456db..4cbc744 100644 (file)
 #ifndef _LUSTRE_DISK_H
 #define _LUSTRE_DISK_H
 
+/** \defgroup disk disk
+ *
+ * @{
+ */
+
 #include <libcfs/libcfs.h>
 #include <lnet/types.h>
 
@@ -472,4 +477,6 @@ int mgc_fsname2resid(char *fsname, struct ldlm_res_id *res_id);
 
 #endif
 
+/** @} disk */
+
 #endif // _LUSTRE_DISK_H
index f1e587d..0b175f2 100644 (file)
 #ifndef _LUSTRE_DLM_H__
 #define _LUSTRE_DLM_H__
 
+/** \defgroup ldlm ldlm
+ *
+ * @{
+ */
+
 #if defined(__linux__)
 #include <linux/lustre_dlm.h>
 #elif defined(__APPLE__)
@@ -1180,4 +1185,7 @@ void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
+
+/** @} ldlm */
+
 #endif
index f2281ba..80906f4 100644 (file)
 #ifndef _LUSTRE_EACL_H
 #define _LUSTRE_EACL_H
 
+/** \defgroup eacl eacl
+ *
+ * @{
+ */
+
 #ifdef CONFIG_FS_POSIX_ACL
 
 # ifdef HAVE_XATTR_ACL
@@ -109,4 +114,6 @@ lustre_acl_xattr_merge2ext(posix_acl_xattr_header *posix_header, int size,
 
 #endif /* CONFIG_FS_POSIX_ACL */
 
+/** @} eacl */
+
 #endif
index b319457..eb25365 100644 (file)
 #ifndef __EXPORT_H
 #define __EXPORT_H
 
+/** \defgroup export export
+ *
+ * @{
+ */
+
 #include <lprocfs_status.h>
 #include <lustre/lustre_idl.h>
 #include <lustre_dlm.h>
@@ -275,4 +280,6 @@ static inline int imp_connect_lru_resize(struct obd_import *imp)
 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
 
+/** @} export */
+
 #endif /* __EXPORT_H */
index 6e952b5..0b18f23 100644 (file)
 #ifndef __LINUX_FID_H
 #define __LINUX_FID_H
 
+/** \defgroup fid fid
+ *
+ * @{
+ */
+
 /*
  * struct lu_fid
  */
@@ -347,4 +352,6 @@ static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq
         dst->lsr_mdt = be32_to_cpu(src->lsr_mdt);
 }
 
+/** @} fid */
+
 #endif /* __LINUX_FID_H */
index 9d46541..da971ab 100644 (file)
 #ifndef __LINUX_FLD_H
 #define __LINUX_FLD_H
 
+/** \defgroup fld fld
+ *
+ * @{
+ */
+
 #include <lustre/lustre_idl.h>
 #include <lustre_mdt.h>
 #include <dt_object.h>
@@ -189,4 +194,6 @@ int fld_client_add_target(struct lu_client_fld *fld,
 int fld_client_del_target(struct lu_client_fld *fld,
                           __u64 idx);
 
+/** @} fld */
+
 #endif
index 7d5b8f1..a9cdbc0 100644 (file)
 #ifndef _LUSTRE_HA_H
 #define _LUSTRE_HA_H
 
+/** \defgroup ha ha
+ *
+ * @{
+ */
+
 struct obd_import;
 struct obd_export;
 struct obd_device;
@@ -57,4 +62,6 @@ int ptlrpc_check_suspend(void);
 void ptlrpc_activate_timeouts(struct obd_import *imp);
 void ptlrpc_deactivate_timeouts(struct obd_import *imp);
 
+/** @} ha */
+
 #endif
index aa05d4a..5db904e 100644 (file)
 #ifndef __LUSTRE_HANDLES_H_
 #define __LUSTRE_HANDLES_H_
 
+/** \defgroup handles handles
+ *
+ * @{
+ */
+
 #if defined(__linux__)
 #include <linux/lustre_handles.h>
 #elif defined(__APPLE__)
@@ -90,4 +95,6 @@ void class_handle_free_cb(cfs_rcu_head_t *);
 int class_handle_init(void);
 void class_handle_cleanup(void);
 
+/** @} handles */
+
 #endif
index 364a651..fa14de1 100644 (file)
 #ifndef _LUSTRE_IDMAP_H
 #define _LUSTRE_IDMAP_H
 
+/** \defgroup idmap idmap
+ *
+ * @{
+ */
+
 #include <md_object.h>
 
 #define CFS_NGROUPS_PER_BLOCK   ((int)(CFS_PAGE_SIZE / sizeof(gid_t)))
@@ -92,4 +97,6 @@ extern int lustre_idmap_lookup_gid(struct md_ucred *mu,
 extern struct lustre_idmap_table *lustre_idmap_init(void);
 extern void lustre_idmap_fini(struct lustre_idmap_table *t);
 
+/** @} idmap */
+
 #endif
index ebcc46f..46b039d 100644 (file)
 #ifndef __IMPORT_H
 #define __IMPORT_H
 
+/** \defgroup export export
+ *
+ * @{
+ */
+
 #include <lustre_handles.h>
 #include <lustre/lustre_idl.h>
 
@@ -248,4 +253,6 @@ struct obd_export;
 extern struct obd_import *class_exp2cliimp(struct obd_export *);
 extern struct obd_import *class_conn2cliimp(struct lustre_handle *);
 
+/** @} import */
+
 #endif /* __IMPORT_H */
index 6be3c11..d15277c 100644 (file)
 #ifndef _LUSTRE_LIB_H
 #define _LUSTRE_LIB_H
 
+/** \defgroup lib lib
+ *
+ * @{
+ */
+
 #include <libcfs/libcfs.h>
 #include <lustre/lustre_idl.h>
 #include <lustre_ver.h>
@@ -819,4 +824,6 @@ do {                                                                    \
 #define LIBLUSTRE_CLIENT (1)
 #endif
 
+/** @} lib */
+
 #endif /* _LUSTRE_LIB_H */
index c9c1129..13093e7 100644 (file)
 #ifndef _LL_H
 #define _LL_H
 
+/** \defgroup lite lite
+ *
+ * @{
+ */
+
 #if defined(__linux__)
 #include <linux/lustre_lite.h>
 #elif defined(__APPLE__)
@@ -149,4 +154,7 @@ static inline unsigned long hash_x_index(unsigned long value)
 {
         return ~0UL - value;
 }
+
+/** @} lite */
+
 #endif
index 6b21ff0..2effa25 100644 (file)
 #ifndef _LUSTRE_LOG_H
 #define _LUSTRE_LOG_H
 
+/** \defgroup log log
+ *
+ * @{
+ */
+
 #if defined(__linux__)
 #include <linux/lustre_log.h>
 #elif defined(__APPLE__)
@@ -688,4 +693,6 @@ int lustre_process_log(struct super_block *sb, char *logname,
 int lustre_end_log(struct super_block *sb, char *logname,
                    struct config_llog_instance *cfg);
 
+/** @} log */
+
 #endif
index a30c2ec..381a676 100644 (file)
 #ifndef _LUSTRE_MDC_H
 #define _LUSTRE_MDC_H
 
+/** \defgroup mdc mdc
+ *
+ * @{
+ */
+
 #ifdef __KERNEL__
 # include <linux/fs.h>
 # include <linux/dcache.h>
@@ -132,4 +137,7 @@ int it_open_error(int phase, struct lookup_intent *it);
 int mdc_sendpage(struct obd_export *exp, const struct lu_fid *fid,
                  const struct page *page, int offset);
 #endif
+
+/** @} mdc */
+
 #endif
index 56a5cf0..59951fc 100644 (file)
 #ifndef _LUSTRE_MDS_H
 #define _LUSTRE_MDS_H
 
+/** \defgroup mds mds
+ *
+ * @{
+ */
+
 #include <lustre_handles.h>
 #include <libcfs/libcfs.h>
 #include <lustre/lustre_idl.h>
@@ -91,4 +96,6 @@ static inline int md_should_create(__u32 flags)
 /* these are local flags, used only on the client, private */
 #define M_CHECK_STALE           0200000000
 
+/** @} mds */
+
 #endif
index f7b3ec4..0375f55 100644 (file)
 #ifndef __LINUX_MDT_H
 #define __LINUX_MDT_H
 
+/** \defgroup mdt mdt
+ *
+ * @{
+ */
+
 #include <lustre/lustre_idl.h>
 #include <lustre_req_layout.h>
 #include <md_object.h>
@@ -76,5 +81,6 @@ static inline int is_serious(int rc)
         return (rc < 0 && -rc & ESERIOUS);
 }
 
+/** @} mdt */
 
 #endif
index b91459f..c5ab340 100644 (file)
 #ifndef _LUSTRE_NET_H
 #define _LUSTRE_NET_H
 
+/** \defgroup net net
+ *
+ * @{
+ */
+
 #if defined(__linux__)
 #include <linux/lustre_net.h>
 #elif defined(__APPLE__)
@@ -1398,4 +1403,6 @@ int llog_catinfo(struct ptlrpc_request *req);
 /* ptlrpc/llog_client.c */
 extern struct llog_operations llog_client_ops;
 
+/** @} net */
+
 #endif
index 76e60a7..adeabc6 100644 (file)
 #ifndef _LUSTRE_PARAM_H
 #define _LUSTRE_PARAM_H
 
+/** \defgroup param param
+ *
+ * @{
+ */
+
 /* obd_config.c */
 int class_find_param(char *buf, char *key, char **valp);
 int class_get_next_param(char **params, char *copy);
@@ -91,4 +96,6 @@ int do_lcfg(char *cfgname, lnet_nid_t nid, int cmd,
 #define PARAM_SRPC_UDESC           "srpc.udesc.cli2mdt"
 #define PARAM_SEC                  "security."
 
+/** @} param */
+
 #endif /* _LUSTRE_PARAM_H */
index 03db1da..f9d1e15 100644 (file)
 #ifndef _LUSTRE_QUOTA_H
 #define _LUSTRE_QUOTA_H
 
+/** \defgroup quota quota
+ *
+ * @{
+ */
+
 #if defined(__linux__)
 #include <linux/lustre_quota.h>
 #elif defined(__APPLE__)
@@ -815,4 +820,6 @@ extern quota_interface_t lmv_quota_interface;
         "admin_quotafile_v2.grp"        /** group admin quotafile */\
 }
 
+/** @} quota */
+
 #endif /* _LUSTRE_QUOTA_H */
index ef8d2ec..8fc14e5 100644 (file)
 #ifndef _LUSTRE_REQ_LAYOUT_H__
 #define _LUSTRE_REQ_LAYOUT_H__
 
+/** \defgroup req_layout req_layout
+ *
+ * @{
+ */
+
 struct req_msg_field;
 struct req_format;
 struct req_capsule;
@@ -278,4 +283,6 @@ extern const struct req_msg_field RMF_RCS;
 extern const struct req_msg_field RMF_FIEMAP_KEY;
 extern const struct req_msg_field RMF_FIEMAP_VAL;
 
+/** @} req_layout */
+
 #endif /* _LUSTRE_REQ_LAYOUT_H__ */
index 691c0c0..0e46c40 100644 (file)
 #ifndef _LUSTRE_SEC_H_
 #define _LUSTRE_SEC_H_
 
+/** \defgroup sec sec
+ *
+ * @{
+ */
+
 /*
  * to avoid include
  */
@@ -818,4 +823,6 @@ enum {
         LUSTRE_SEC_ALL          = 3
 };
 
+/** @} sec */
+
 #endif /* _LUSTRE_SEC_H_ */
index f9c7ded..aa5d8d9 100644 (file)
 #ifndef _UPCALL_CACHE_H
 #define _UPCALL_CACHE_H
 
+/** \defgroup ucache ucache
+ *
+ * @{
+ */
+
 #define UC_CACHE_NEW            0x01
 #define UC_CACHE_ACQUIRING      0x02
 #define UC_CACHE_INVALID        0x04
@@ -149,4 +154,7 @@ struct upcall_cache *upcall_cache_init(const char *name);
 void upcall_cache_cleanup(struct upcall_cache *hash);
 
 #endif
+
+/** @} ucache */
+
 #endif /* _UPCALL_CACHE_H */