Fix doxygen warnings

HDFGroup · Nov 28, 2022 · b35c906 · b35c906
1 parent cb2273b
commit b35c906
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 2 deletions.
diff --git a/adapter/adapter_generator/adapter_generator/create_interceptor.py b/adapter/adapter_generator/adapter_generator/create_interceptor.py
@@ -156,6 +156,7 @@ def _CreateH(self, namespace, includes, path):
         # Create the class definition
         self.h_lines.append(f"namespace hermes::adapter::{namespace} {{")
         self.h_lines.append(f"")
+        self.h_lines.append(f"/** Pointers to the real {namespace} API */")
         self.h_lines.append(f"class API {{")
 
         # Create class function pointers

diff --git a/adapter/filesystem/filesystem.h b/adapter/filesystem/filesystem.h
@@ -201,6 +201,11 @@ struct IoOptions {
     return opts;
   }
 
+  /**
+   * Ensure that I/O goes only to Hermes, and does not fall back to PFS.
+   *
+   * @param orig_opts The original options to modify
+   * */
   static IoOptions PlaceInHermes(IoOptions &orig_opts) {
     IoOptions opts(orig_opts);
     opts.seek_ = false;

diff --git a/adapter/mpiio/real_api.h b/adapter/mpiio/real_api.h
@@ -62,6 +62,7 @@ typedef int (*MPI_File_sync_t)(MPI_File fh);
 
 namespace hermes::adapter::mpiio {
 
+/** Pointers to the real mpiio API */
 class API {
  public:
   /** MPI_Init */

diff --git a/adapter/posix/real_api.h b/adapter/posix/real_api.h
@@ -54,6 +54,7 @@ typedef int (*close_t)(int fd);
 
 namespace hermes::adapter::posix {
 
+/** Pointers to the real posix API */
 class API {
  public:
   /** MPI_Init */

diff --git a/adapter/stdio/real_api.h b/adapter/stdio/real_api.h
@@ -61,6 +61,7 @@ typedef long int (*ftell_t)(FILE * fp);
 
 namespace hermes::adapter::stdio {
 
+/** Pointers to the real stdio API */
 class API {
  public:
   /** MPI_Init */

diff --git a/src/api/vbucket.h b/src/api/vbucket.h
@@ -163,9 +163,10 @@ class VBucket {
   size_t Get(const std::string &name, Bucket *bkt, void *user_blob,
              size_t blob_size, const Context &ctx);
 
-  /** retrieves the subset of blob links satisfying pred */
-  /** could return iterator */
+  /** retrieves all blob links */
   std::vector<std::string> GetLinks();
+
+  /** retrieves all blob links subject to a predicte in \a ctx */
   std::vector<std::string> GetLinks(Context &ctx);
 
   /** \brief Attach a Trait to this VBucket.