Add some documentation

Gu1nness · Feb 7, 2019 · cfd25fc · cfd25fc
1 parent cd10ff6
commit cfd25fc
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "CInterpreter"]
+	path = CInterpreter
+	url = [email protected]:SKantar/CInterpreter.git
diff --git a/CInterpreter b/CInterpreter
diff --git a/dwarf_handler.py b/dwarf_handler.py
@@ -39,6 +39,9 @@ def create_variables(file):
 
 
 class Tag():
+    """The base class defining a DW_TAG_* structure, with a simple
+    representation method.
+    """
     def __init__():
         return
 
@@ -54,6 +57,11 @@ def __str__(self):
 
 
 class CompileUnitTree():
+    """ A compile unit, described as a tree. Should contain all the necessary
+    information : subprograms, structures, etc.
+    Provides many public methods in order to perform IP lookup, variable
+    location computation, etc.
+    """
     def __init__(self, compile_unit, dwarfinfo):
         self.tag = "DW_TAG_compile_unit"
         self.structures = []