Add symtab/indexed_modules.h

dyninst · Apr 3, 2024 · 13a9e77 · 13a9e77
1 parent 55d02f2
commit 13a9e77
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/docs/symtabAPI/developer/indexed_modules.h.rst b/docs/symtabAPI/developer/indexed_modules.h.rst
@@ -3,5 +3,33 @@
 indexed_modules.h
 #################
 
-.. cpp:namespace:: Dyninst
+.. cpp:namespace:: Dyninst::SymtabAPI
 
+.. cpp:class:: indexed_modules
+
+  .. cpp:function:: void insert(Module *m)
+  .. cpp:function:: bool contains(Module *m) const
+  .. cpp:function:: std::vector<Module *> find(std::string const& name) const
+  .. cpp:function:: Module *find(Dyninst::Offset offset) const
+  .. cpp:function:: bool empty() const
+  .. cpp:function:: iterator begin()
+  .. cpp:function:: iterator end()
+  .. cpp:function:: const_iterator cbegin() const
+  .. cpp:function:: const_iterator cend() const
+
+
+.. cpp:namespace-push:: detail
+
+.. cpp:struct:: hash
+
+  A Module is uniquely identified by its name and offset
+
+  .. cpp:function:: size_t operator()(Module *m) const
+
+
+.. cpp:struct:: equal
+
+  .. cpp:function:: bool operator()(Module *m1, Module *m2) const
+
+.. cpp:namespace-pop::
+  
diff --git a/symtabAPI/src/indexed_modules.h b/symtabAPI/src/indexed_modules.h
@@ -39,7 +39,6 @@
 namespace Dyninst { namespace SymtabAPI {
 
   namespace detail {
-    // A Module is uniquely identified by its name and offset
     struct hash {
       size_t operator()(Module *m) const {
         size_t seed{0UL};