Skip to content

Commit

Permalink
Add dyninstAPI developer doc stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
@hainest
hainest committed Apr 3, 2024
1 parent 06a5769 commit 1b1f9d0
Show file tree
Hide file tree
Showing 107 changed files with 495 additions and 1,163 deletions.
4 changes: 4 additions & 0 deletions docs/dyninstAPI/developer/API.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ DyninstAPI
:hidden:
:maxdepth: 1

Relocation/API
StackMod/API

arch-forward-decl.h
addressSpace.h
ast.h
baseTramp.h
Expand Down
6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/BPatch_collections.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
BPatch_collections.h
====================
.. _`sec:BPatch_collections.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
BPatch_collections.h
####################

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/BPatch_libInfo.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
BPatch_libInfo.h
================
.. _`sec:BPatch_libInfo.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
BPatch_libInfo.h
################

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/BPatch_memoryAccessAdapter.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
BPatch_memoryAccessAdapter.h
============================
.. _`sec:BPatch_memoryAccessAdapter.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
BPatch_memoryAccessAdapter.h
############################

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/BPatch_private.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
BPatch_private.h
================
.. _`sec:BPatch_private.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
BPatch_private.h
################

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/ELF_Section.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ELF_Section.h
=============
.. _`sec:ELF_Section.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
ELF_Section.h
#############

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/IAPI_to_AST.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
IAPI_to_AST.h
=============
.. _`sec:IAPI_to_AST.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
IAPI_to_AST.h
#############

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/LinearVariable.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
LinearVariable.h
================
.. _`sec:LinearVariable.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
LinearVariable.h
################

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/Parsing.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Parsing.h
=========
.. _`sec:Parsing.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
Parsing.h
#########

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/Patching.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Patching.h
==========
.. _`sec:Patching.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
Patching.h
##########

6 changes: 3 additions & 3 deletions docs/dyninstAPI/developer/RegisterConversion.h.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
RegisterConversion.h
====================
.. _`sec:RegisterConversion.h`:

.. cpp:namespace:: Dyninst::dyninstAPI
RegisterConversion.h
####################

24 changes: 24 additions & 0 deletions docs/dyninstAPI/developer/Relocation/API.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
==========
Relocation
==========

.. toctree::
:caption: Developer API
:name: dyninstapi-developer-relocation
:hidden:
:maxdepth: 1

CFG/API
Transformers/API
Widgets/API

CodeBuffer.h
CodeMover.h
CodeTracker.h
DynAddrSpace.h
DynCommon.h
DynInstrumenter.h
DynObject.h
DynPointMaker.h
Relocation.h
Springboard.h
14 changes: 14 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CFG/API.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
===
CFG
===

.. toctree::
:caption: Developer API
:name: dyninstapi-developer-relocation-cfg
:hidden:
:maxdepth: 1

RelocBlock.h
RelocEdge.h
RelocGraph.h
RelocTarget.h
8 changes: 8 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CFG/RelocBlock.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _`sec:RelocBlock.h`:

RelocBlock.h
############

.. cpp:namespace:: Dyninst::Relocation

w
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CFG/RelocEdge.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:RelocEdge.h`:

RelocEdge.h
###########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CFG/RelocGraph.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:RelocGraph.h`:

RelocGraph.h
############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CFG/RelocTarget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:RelocTarget.h`:

RelocTarget.h
#############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CodeBuffer.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:CodeBuffer.h`:

CodeBuffer.h
############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CodeMover.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:CodeMover.h`:

CodeMover.h
###########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/CodeTracker.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:CodeTracker.h`:

CodeTracker.h
#############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/DynAddrSpace.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:DynAddrSpace.h`:

DynAddrSpace.h
##############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/DynCommon.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:DynCommon.h`:

DynCommon.h
###########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/DynInstrumenter.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:DynInstrumenter.h`:

DynInstrumenter.h
#################

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/DynObject.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:DynObject.h`:

DynObject.h
###########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/DynPointMaker.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:DynPointMaker.h`:

DynPointMaker.h
###############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Relocation.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Relocation.h`:

Relocation.h
############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Springboard.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Springboard.h`:

Springboard.h
#############

.. cpp:namespace:: Dyninst::Relocation
16 changes: 16 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Transformers/API.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
============
Transformers
============

.. toctree::
:caption: Developer API
:name: dyninstapi-developer-relocation-transformers
:hidden:
:maxdepth: 1

Include.h
Instrumenter.h
Modification.h
Movement-adhoc.h
Movement-analysis.h
Transformer.h
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Transformers/Include.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Include.h`:

Include.h
#########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Transformers/Instrumenter.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:dyninstAPI:Instrumenter.h`:

Instrumenter.h
##############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Transformers/Modification.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Modification.h`:

Modification.h
##############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Transformers/Movement-adhoc.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Movement-adhoc.h`:

Movement-adhoc.h
################

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Transformers/Movement-analysis.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Movement-analysis.h`:

Movement-analysis.h
###################

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Transformers/Transformer.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Transformer.h`:

Transformer.h
#############

.. cpp:namespace:: Dyninst::Relocation
20 changes: 20 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/API.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
=======
Widgets
=======

.. toctree::
:caption: Developer API
:name: dyninstapi-developer-relocation-widgets
:hidden:
:maxdepth: 1

ASTWidget.h
CallbackWidget.h
CFWidget.h
Include.h
InsnWidget.h
InstWidget.h
PCWidget.h
RelDataWidget.h
StackModWidget.h
Widget.h
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/ASTWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:ASTWidget.h`:

ASTWidget.h
###########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/CFWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:CFWidget.h`:

CFWidget.h
##########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/CallbackWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:CallbackWidget.h`:

CallbackWidget.h
################

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/Include.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Include.h`:

Include.h
#########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/InsnWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:InsnWidget.h`:

InsnWidget.h
############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/InstWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:InstWidget.h`:

InstWidget.h
############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/PCWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:PCWidget.h`:

PCWidget.h
##########

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/RelDataWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:RelDataWidget.h`:

RelDataWidget.h
###############

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/StackModWidget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:StackModWidget.h`:

StackModWidget.h
################

.. cpp:namespace:: Dyninst::Relocation
6 changes: 6 additions & 0 deletions docs/dyninstAPI/developer/Relocation/Widgets/Widget.h.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _`sec:Widget.h`:

Widget.h
########

.. cpp:namespace:: Dyninst::Relocation

0 comments on commit 1b1f9d0

Please sign in to comment.