[coco] Reformat comments into doxygen style (#2942)

Doxygen cannot parse comments with '// @brief'. Now such comments are
reformatted to style that doxygen can parse as documentation.

Signed-off-by: Cheongyo Bahk <ch.bahk@samsung.com>

diff --git a/contrib/coco/core/include/coco/ADT/DLinkedList.h b/contrib/coco/core/include/coco/ADT/DLinkedList.h
index 689111f..e3c2750 100644 (file)
--- a/contrib/coco/core/include/coco/ADT/DLinkedList.h
+++ b/contrib/coco/core/include/coco/ADT/DLinkedList.h
@@ -26,9 +26,9 @@ namespace coco
 // **CAUTION** Child SHOULD inherit DLinkedList<Child, Parent>::Node
 template <typename Child, typename Parent> struct DLinkedList
 {
-  // @brief A hook for Child-Join event
+  /// @brief A hook for Child-Join event
   static void joined(Parent *, Child *);
-  // @brief A hook for Child-Leave event
+  /// @brief A hook for Child-Leave event
   static void leaving(Parent *, Child *);
 
   class Head

diff --git a/contrib/coco/core/include/coco/IR/Bag.h b/contrib/coco/core/include/coco/IR/Bag.h
index 0c71b6e..1c86899 100644 (file)
--- a/contrib/coco/core/include/coco/IR/Bag.h
+++ b/contrib/coco/core/include/coco/IR/Bag.h
@@ -82,28 +82,32 @@ public:
   bool isOutput(void) const;
 
 public:
-  // @brief Return the set of Dep links that point to this bag
+  /// @brief Return the set of Dep links that point to this bag
   const DepSet *deps(void) const;
-  // @brief Return the set of Read links that point to this bag
+  /// @brief Return the set of Read links that point to this bag
   const ReadSet *reads(void) const;
-  // @brief Return the set of Update links that point to this bag
+  /// @brief Return the set of Update links that point to this bag
   const UpdateSet *updates(void) const;
 
 public:
-  // @brief Return a valid pointer if this bag is marked as an input of the model
+  /// @brief Return a valid pointer if this bag is marked as an input of the model
   Input *input(void) const { return _input; }
-  // @brief Return a valid pointer if this bag is marked as an output of the model
+  /// @brief Return a valid pointer if this bag is marked as an output of the model
   Output *output(void) const { return _output; }
 
 public:
-  // @brief Replace all the occurence of a bag (except those in Input/Output) with another bag
-  //
-  // NOTE reaplceWith(b) works correctly only when b is neither Input nor Output
+  /**
+   * @brief Replace all the occurence of a bag (except those in Input/Output) with another bag
+   *
+   * NOTE reaplceWith(b) works correctly only when b is neither Input nor Output
+   */
   void replaceWith(Bag *b);
 
-  // @brief Replace all the occurence of a bag in Object with another bag
-  //
-  // NOTE Unlike replaceWith(b), replaceAllDepsWith(b) has no restriction
+  /**
+   * @brief Replace all the occurence of a bag in Object with another bag
+   *
+   * NOTE Unlike replaceWith(b), replaceAllDepsWith(b) has no restriction
+   */
   void replaceAllDepsWith(Bag *);
 
 private:
@@ -148,11 +152,11 @@ private:
   Output *_output = nullptr;
 };
 
-// @brief Return a set of objects that depends on a given bag
+/// @brief Return a set of objects that depends on a given bag
 ObjectSet dependent_objects(const Bag *);
-// @brief Return a set of readers that reads a given bag
+/// @brief Return a set of readers that reads a given bag
 Bag::ReaderSet readers(const Bag *);
-// @brief Return a set of updaters that updates a given bag
+/// @brief Return a set of updaters that updates a given bag
 Bag::UpdaterSet updaters(const Bag *);
 
 } // namespace coco

diff --git a/contrib/coco/core/include/coco/IR/BagManager.h b/contrib/coco/core/include/coco/IR/BagManager.h
index 8fe7a41..6ba6441 100644 (file)
--- a/contrib/coco/core/include/coco/IR/BagManager.h
+++ b/contrib/coco/core/include/coco/IR/BagManager.h
@@ -34,9 +34,11 @@ public:
   Bag *create(uint32_t size);
 
 public:
-  // @brief Destroy (= deallocate) a Bag entity
-  //
-  // NOTE A Bag SHOULD BE detached from IR before destruction
+  /**
+   * @brief Destroy (= deallocate) a Bag entity
+   *
+   * NOTE A Bag SHOULD BE detached from IR before destruction
+   */
   void destroy(Bag *b);
 };
 

diff --git a/contrib/coco/core/include/coco/IR/InstrManager.h b/contrib/coco/core/include/coco/IR/InstrManager.h
index 1bc6cc7..537467a 100644 (file)
--- a/contrib/coco/core/include/coco/IR/InstrManager.h
+++ b/contrib/coco/core/include/coco/IR/InstrManager.h
@@ -42,10 +42,12 @@ public:
   template <typename Ins> Ins *create(void);
 
 public:
-  // @brief Destroy (= deallocate) an Instr instance
-  //
-  // NOTE destroy(ins) WILL NOT update ins->parent(). An Instruction SHOULD BE detacted from a
-  //      module before destroy call
+  /**
+   * @brief Destroy (= deallocate) an Instr instance
+   *
+   * NOTE destroy(ins) WILL NOT update ins->parent(). An Instruction SHOULD BE detacted from a
+   *      module before destroy call
+   */
   void destroy(Instr *);
 };
 

diff --git a/contrib/coco/core/include/coco/IR/Instrs.h b/contrib/coco/core/include/coco/IR/Instrs.h
index 4d46b80..9245443 100644 (file)
--- a/contrib/coco/core/include/coco/IR/Instrs.h
+++ b/contrib/coco/core/include/coco/IR/Instrs.h
@@ -136,16 +136,18 @@ public:
   void into(Bag *);
 
 public:
-  // @brief Return the number of Element-wise transfers
-  //
-  // NOTE size() SHOULD BE identical to range().size()
+  /**
+   * @brief Return the number of Element-wise transfers
+   *
+   * NOTE size() SHOULD BE identical to range().size()
+   */
   uint32_t size(void) const;
 
-  // @brief Return a set of elements in the destination bag that Shuffle will update
+  /// @brief Return a set of elements in the destination bag that Shuffle will update
   std::set<ElemID> range(void) const;
 
 public:
-  // @brief Return true if a given elem is updated after execution
+  /// @brief Return true if a given elem is updated after execution
   bool defined(const ElemID &dst) const { return _content.find(dst) != _content.end(); }
 
 public:

diff --git a/contrib/coco/core/include/coco/IR/Object.h b/contrib/coco/core/include/coco/IR/Object.h
index 28daefa..617e8a1 100644 (file)
--- a/contrib/coco/core/include/coco/IR/Object.h
+++ b/contrib/coco/core/include/coco/IR/Object.h
@@ -86,9 +86,11 @@ public:
   const UseSet *uses(void) const;
 
 private:
-  // @brief Update the link to a producer
-  //
-  // WARN Only Def class is allowed to access this method
+  /**
+   * @brief Update the link to a producer
+   *
+   * WARN Only Def class is allowed to access this method
+   */
   void def(Def *d);
 
   // NOTE "mutable_" prefix is introduced to avoid resolution issue similarly as in Bag
@@ -131,10 +133,10 @@ template <typename T> T *cast(Object *);
  */
 template <typename T> T *safe_cast(Object *);
 
-// @brief Return the producer of a given object if it exists
+/// @brief Return the producer of a given object if it exists
 Object::Producer *producer(const Object *);
 
-// @brief Return a set of consumers of a given object.
+/// @brief Return a set of consumers of a given object.
 Object::ConsumerSet consumers(const Object *);
 
 } // namespace coco

diff --git a/contrib/coco/core/include/coco/IR/Op.h b/contrib/coco/core/include/coco/IR/Op.h
index 46d42f5..090527e 100644 (file)
--- a/contrib/coco/core/include/coco/IR/Op.h
+++ b/contrib/coco/core/include/coco/IR/Op.h
@@ -157,19 +157,23 @@ public:
 public:
   Instr *parent(void) const;
 
-  // @brief Return a pointer to the parent Op
+  /// @brief Return a pointer to the parent Op
   Op *up(void) const;
 
 private:
-  // @brief A link to Instr from Op
-  //
-  // WARN Update this field only through Step
+  /**
+   * @brief A link to Instr from Op
+   *
+   * WARN Update this field only through Step
+   */
   Step *_step = nullptr;
 
-  // @brief A link to a parent Op
-  //
-  // WARN Update this field only through Part
-  // NOTE An "Op" CANNOT have a link to a parent Op if it is linked to an "Instr"
+  /**
+   * @brief A link to a parent Op
+   *
+   * WARN Update this field only through Part
+   * NOTE An "Op" CANNOT have a link to a parent Op if it is linked to an "Instr"
+   */
   Part *_part = nullptr;
 };
 
@@ -199,7 +203,7 @@ public:
   void arg(Op *arg) { _arg.child(arg); }
 
 private:
-  // @brief Link to Op's argument
+  /// @brief Link to Op's argument
   Part _arg;
 };
 
@@ -233,9 +237,9 @@ public:
   void right(Op *op) { _right.child(op); }
 
 private:
-  // @brief Left-hand side (LHS) argument
+  /// @brief Left-hand side (LHS) argument
   Part _left;
-  // @brief Right-hand side (RHS) argument
+  /// @brief Right-hand side (RHS) argument
   Part _right;
 };
 

diff --git a/contrib/coco/core/include/coco/IR/OpManager.h b/contrib/coco/core/include/coco/IR/OpManager.h
index a86e581..2c88867 100644 (file)
--- a/contrib/coco/core/include/coco/IR/OpManager.h
+++ b/contrib/coco/core/include/coco/IR/OpManager.h
@@ -43,14 +43,18 @@ public:
   template <typename T> T *create(void);
 
 public:
-  // @brief Destroy (= deallocate) a Op instance
-  //
-  // NOTE destroy(op) WILL NOT update op->parent(). Client SHOULD detach op before destroy(op) call
+  /**
+   * @brief Destroy (= deallocate) a Op instance
+   *
+   * NOTE destroy(op) WILL NOT update op->parent(). Client SHOULD detach op before destroy(op) call
+   */
   void destroy(Op *);
 
-  // @brief Destroy a Op tree
-  //
-  // @require op->parent() == nullptr && op->up() == nullptr
+  /**
+   * @brief Destroy a Op tree
+   *
+   * @require op->parent() == nullptr && op->up() == nullptr
+   */
   void destroy_all(Op *);
 };
 

diff --git a/contrib/coco/core/include/coco/IR/Ops.h b/contrib/coco/core/include/coco/IR/Ops.h
index 4f2169d..01ac92b 100644 (file)
--- a/contrib/coco/core/include/coco/IR/Ops.h
+++ b/contrib/coco/core/include/coco/IR/Ops.h
@@ -131,7 +131,7 @@ private:
   Stride2D _stride;
 
 private:
-  // @brief Link to an argument of Conv2D operation (= IFM)
+  /// @brief Link to an argument of Conv2D operation (= IFM)
   Part _arg;
 };