Add dyninstAPI/BPatch_parRegion.h

dyninst · Apr 3, 2024 · b43722c · b43722c
1 parent 6bb9a19
commit b43722c
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 18 deletions.
diff --git a/docs/dyninstAPI/public/BPatch_parRegion.h.rst b/docs/dyninstAPI/public/BPatch_parRegion.h.rst
@@ -1,5 +1,48 @@
+.. _`sec:BPatch_parRegion.h`:
+
 BPatch_parRegion.h
-==================
+##################
+
+.. cpp:enum:: parRegType
+
+  .. cpp:enumerator:: OMP_NONE
+  .. cpp:enumerator:: OMP_PARALLEL
+  .. cpp:enumerator:: OMP_DO_FOR
+  .. cpp:enumerator:: OMP_DO_FOR_LOOP_BODY
+  .. cpp:enumerator:: OMP_SECTIONS
+  .. cpp:enumerator:: OMP_SINGLE
+  .. cpp:enumerator:: OMP_PAR_DO
+  .. cpp:enumerator:: OMP_PAR_SECTIONS
+  .. cpp:enumerator:: OMP_MASTER
+  .. cpp:enumerator:: OMP_CRITICAL
+  .. cpp:enumerator:: OMP_BARRIER
+  .. cpp:enumerator:: OMP_ATOMIC
+  .. cpp:enumerator:: OMP_FLUSH
+  .. cpp:enumerator:: OMP_ORDERED
+  .. cpp:enumerator:: OMP_ANY
+
+
+.. cpp:class:: BPatch_parRegion
+
+  .. cpp:function:: BPatch_parRegion(int_parRegion * _parReg, BPatch_function * _func)
+  .. cpp:function:: ~BPatch_parRegion()
+  .. cpp:function:: int_parRegion *lowlevel_region() const
+  .. cpp:function:: void printDetails()
+  .. cpp:function:: int getClause(const char * key)
+  .. cpp:function:: int replaceOMPParameter(const char * key, int value)
+
+  .. cpp:function:: BPatch_Vector<BPatch_instruction *> * getInstructions()
+
+    Returns the instructions that belong to the block.
+
+  .. cpp:function:: bool getInstructions(std::vector<Dyninst::InstructionAPI::Instruction>& insns)
+
+  .. cpp:function:: unsigned size() const
+
+  .. cpp:function:: unsigned long getStartAddress() const
+
+    Returns absolute starting address.
 
-.. cpp:namespace:: Dyninst::dyninstAPI
+  .. cpp:function:: unsigned long getEndAddress() const
 
+    Returns absolute ending address.
diff --git a/dyninstAPI/h/BPatch_parRegion.h b/dyninstAPI/h/BPatch_parRegion.h
@@ -59,40 +59,24 @@ class BPATCH_DLL_EXPORT BPatch_parRegion {
   void printDetails();
 
 
-  /** BPatch_basicBlock::getClause    */
-
   int  getClause(const char * key);
 
-
-  /** BPatch_basicBlock::replaceOMPParameter    */
-
   int  replaceOMPParameter(const char * key, int value);
 
 
-  /** BPatch_parRegion::getInstructions   */
-  /** return the instructions that belong to the block */
-
   BPatch_Vector<BPatch_instruction *> * getInstructions();
 
   bool  getInstructions(std::vector<Dyninst::InstructionAPI::Instruction>& insns);
 
 
-  /** BPatch_parRegion::size   */
-
   unsigned size() const;
 
-  /** BPatch_parRegion::getStartAddress   */
-  //these always return absolute address
-
   unsigned long getStartAddress() const;
 
-  /** BPatch_basicBlock::getEndAddress    */
-
   unsigned long  getEndAddress() const;
 
 
  private:
-  /** the instructions within this region */
   BPatch_Vector<BPatch_instruction*> *instructions;
 
 };