Add dyninstAPI/Relocation.h

dyninst · Apr 3, 2024 · b803d87 · b803d87
1 parent 54912d3
commit b803d87
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/docs/dyninstAPI/developer/Relocation/Relocation.h.rst b/docs/dyninstAPI/developer/Relocation/Relocation.h.rst
@@ -3,4 +3,11 @@
 Relocation.h
 ############
 
+A quick header file defining externally visible types from the PatchAPI
+namespace. This allows us to reduce cross-pollination of header files.
+This avoids the requirement to include CodeMover.h
+
 .. cpp:namespace:: Dyninst::Relocation
+
+.. cpp:type:: boost::shared_ptr<Dyninst::Relocation::CodeMover> CodeMoverPtr
+.. cpp:type:: boost::shared_ptr<Dyninst::Relocation::SpringboardBuilder> SpringboardBuilderPtr
diff --git a/dyninstAPI/src/Relocation/Relocation.h b/dyninstAPI/src/Relocation/Relocation.h
@@ -28,10 +28,6 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-// A quick header file defining externally visible types from the PatchAPI
-// namespace. This allows us to reduce cross-pollination of header files.
-
-
 #if !defined(_RELOCATION_H_)
 #define _RELOCATION_H_
 
@@ -54,5 +50,4 @@ typedef boost::shared_ptr<Dyninst::Relocation::SpringboardBuilder> SpringboardBu
 }
 }
 
-// This avoids the requirement to include CodeMover.h
 #endif