Replace \xxx with @xxx in structured comment. (dmlc#4815)

* replace * more * file * change Co-authored-by: Steve <[email protected]>
mtphil · Nov 4, 2022 · 6c53f35 · 6c53f35
1 parent 33a2d9e
commit 6c53f35
Show file tree

Hide file tree

Showing 32 changed files with 1,497 additions and 1,496 deletions.
diff --git a/featgraph/include/featgraph.h b/featgraph/include/featgraph.h
@@ -1,7 +1,7 @@
 /*!
  *  Copyright (c) 2020 by Contributors
- * \file featgraph/include/featgraph.h
- * \brief FeatGraph kernel headers.
+ * @file featgraph/include/featgraph.h
+ * @brief FeatGraph kernel headers.
  */
 #ifndef FEATGRAPH_H_
 #define FEATGRAPH_H_
@@ -11,10 +11,10 @@
 namespace dgl {
 namespace featgraph {
 
-/* \brief Load Featgraph module from given path. */
+/* @brief Load Featgraph module from given path. */
 void LoadFeatGraphModule(const std::string& path);
 
-/* \brief Call Featgraph's SDDMM kernel. */
+/* @brief Call Featgraph's SDDMM kernel. */
 void SDDMMTreeReduction(
     DLManagedTensor* row, DLManagedTensor* col, DLManagedTensor* lhs,
     DLManagedTensor* rhs, DLManagedTensor* out);

diff --git a/featgraph/src/featgraph.cc b/featgraph/src/featgraph.cc
@@ -1,7 +1,7 @@
 /*!
  *  Copyright (c) 2020 by Contributors
- * \file featgraph/src/featgraph.cc
- * \brief FeatGraph kernels.
+ * @file featgraph/src/featgraph.cc
+ * @brief FeatGraph kernels.
  */
 #include <dmlc/logging.h>
 #include <featgraph.h>
@@ -12,7 +12,7 @@
 namespace dgl {
 namespace featgraph {
 
-/* \brief Singleton that loads the featgraph module. */
+/* @brief Singleton that loads the featgraph module. */
 class FeatGraphModule {
  public:
   static FeatGraphModule* Global() {
@@ -38,12 +38,12 @@ class FeatGraphModule {
   FeatGraphModule() {}
 };
 
-/* \brief Load Featgraph module from given path. */
+/* @brief Load Featgraph module from given path. */
 void LoadFeatGraphModule(const std::string& path) {
   FeatGraphModule::Global()->Load(path);
 }
 
-/* \brief Convert DLDataType to string. */
+/* @brief Convert DLDataType to string. */
 inline std::string DTypeAsStr(const DLDataType& t) {
   switch (t.code) {
     case 0U:
@@ -59,14 +59,14 @@ inline std::string DTypeAsStr(const DLDataType& t) {
   }
 }
 
-/* \brief Get operator filename. */
+/* @brief Get operator filename. */
 inline std::string GetOperatorName(
     const std::string& base_name, const DLDataType& dtype,
     const DLDataType& idtype) {
   return base_name + "_" + DTypeAsStr(dtype) + "_" + DTypeAsStr(idtype);
 }
 
-/* \brief Call FeatGraph's SDDMM kernel. */
+/* @brief Call FeatGraph's SDDMM kernel. */
 void SDDMMTreeReduction(
     DLManagedTensor* row, DLManagedTensor* col, DLManagedTensor* lhs,
     DLManagedTensor* rhs, DLManagedTensor* out) {

diff --git a/featgraph/src/tvm_runtime_pack.cc b/featgraph/src/tvm_runtime_pack.cc
@@ -22,7 +22,7 @@
  */
 
 /*!
- * \brief This is an all in one TVM runtime file.
+ * @brief This is an all in one TVM runtime file.
  *
  *   You only have to use this file to compile libtvm_runtime to
  *   include in your project.

diff --git a/include/dgl/array.h b/include/dgl/array.h
@@ -1,7 +1,7 @@
 /*!
  *  Copyright (c) 2020 by Contributors
- * \file dgl/array.h
- * \brief Common array operations required by DGL.
+ * @file dgl/array.h
+ * @brief Common array operations required by DGL.
  *
  * Note that this is not meant for a full support of array library such as ATen.
  * Only a limited set of operators required by DGL are implemented.

diff --git a/include/dgl/array_iterator.h b/include/dgl/array_iterator.h
@@ -1,7 +1,7 @@
 /*!
  *  Copyright (c) 2020 by Contributors
- * \file dgl/array_iterator.h
- * \brief Various iterators.
+ * @file dgl/array_iterator.h
+ * @brief Various iterators.
  */
 #ifndef DGL_ARRAY_ITERATOR_H_
 #define DGL_ARRAY_ITERATOR_H_

diff --git a/include/dgl/aten/spmat.h b/include/dgl/aten/spmat.h
@@ -1,7 +1,7 @@
 /*!
  *  Copyright (c) 2020 by Contributors
- * \file dgl/aten/spmat.h
- * \brief Sparse matrix definitions
+ * @file dgl/aten/spmat.h
+ * @brief Sparse matrix definitions
  */
 #ifndef DGL_ATEN_SPMAT_H_
 #define DGL_ATEN_SPMAT_H_
@@ -15,7 +15,7 @@
 namespace dgl {
 
 /*!
- * \brief Sparse format.
+ * @brief Sparse format.
  */
 enum class SparseFormat {
   kCOO = 1,
@@ -24,7 +24,7 @@ enum class SparseFormat {
 };
 
 /*!
- * \brief Sparse format codes
+ * @brief Sparse format codes
  */
 const dgl_format_code_t ALL_CODE = 0x7;
 const dgl_format_code_t ANY_CODE = 0x0;

diff --git a/include/dgl/aten/types.h b/include/dgl/aten/types.h
@@ -1,7 +1,7 @@
 /*!
  *  Copyright (c) 2020 by Contributors
- * \file dgl/aten/types.h
- * \brief Array and ID types
+ * @file dgl/aten/types.h
+ * @brief Array and ID types
  */
 #ifndef DGL_ATEN_TYPES_H_
 #define DGL_ATEN_TYPES_H_
@@ -14,7 +14,7 @@ namespace dgl {
 
 typedef uint64_t dgl_id_t;
 typedef uint64_t dgl_type_t;
-/*! \brief Type for dgl fomrat code, whose binary representation indices
+/*! @brief Type for dgl fomrat code, whose binary representation indices
  * which sparse format is in use and which is not.
  *
  * Suppose the binary representation is xyz, then