Update docs/symtabAPI/public/Symtab.h

dyninst · Apr 3, 2024 · b88b468 · b88b468
1 parent a858026
commit b88b468
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 11 deletions.
diff --git a/docs/symtabAPI/developer/Symtab.h.rst b/docs/symtabAPI/developer/Symtab.h.rst
@@ -181,10 +181,6 @@ Symtab.h
   .. cpp:function:: bool getTruncateLinePaths()
   .. cpp:function:: std::string getDefaultNamespacePrefix() const
 
-  .. cpp:function:: Module* findModuleByOffset(Offset offset) const
-
-      Returns the module at the offset ``offset`` in the debug section (e.g., .debug_info).
-
   .. cpp:function:: Module *getDefaultModule() const
 
 
@@ -216,12 +212,6 @@ Symtab.h
 
       Returns ``false`` if no type was found.
 
-  .. cpp:function:: bool addLine(string lineSource, unsigned int lineNo, unsigned int lineOffset, Offset lowInclusiveAddr, Offset highExclusiveAddr)
-
-      This method adds a new line to the line map. ``lineSource`` represents
-      the source file name. ``lineNo`` represents the line number. Returns
-      ``true`` on success and ``false`` on error.
-
   .. cpp:function:: bool addAddressRange(Offset lowInclusiveAddr, Offset highExclusiveAddr, string lineSource, unsigned int lineNo, unsigned int lineOffset = 0);
 
       This method adds an address range

diff --git a/docs/symtabAPI/public/Symtab.h.rst b/docs/symtabAPI/public/Symtab.h.rst
@@ -223,14 +223,20 @@ The Symtab interface is extensive. Use the links below to jump to a particular t
 
       Finds all modules with name ``name``.
 
-      ``name`` should be the full path name as returned by :cpp:func:`file()`. Multiple modules may have the same name.
+      ``name`` should be the full path name as returned by :cpp:func:`file()`.
+
+      .. warning:: Multiple modules may have the same name!
 
   .. cpp:function:: bool findModuleByOffset(Module *& ret, Offset off)
 
       .. deprecated:: 12.3
 
         Use :cpp:func:`Module* findModuleByOffset(Offset) const`.
 
+  .. cpp:function:: Module* findModuleByOffset(Offset offset) const
+
+      Returns the module at the offset ``offset`` in the debug section (e.g., .debug_info).
+
   .. cpp:function:: Module* getContainingModule(Offset offset) const
 
       Returns the module that contains source information for the address range that includes the offset ``offset``.