From cfd25fca12e46de851d4b71cd46bd769a044387e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Oudin?= <oudin@crans.org>
Date: Thu, 7 Feb 2019 14:49:22 +0100
Subject: [PATCH] Add some documentation

---
 .gitmodules      | 3 +++
 CInterpreter     | 1 +
 dwarf_handler.py | 8 ++++++++
 3 files changed, 12 insertions(+)
 create mode 100644 .gitmodules
 create mode 160000 CInterpreter

diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..84728c6
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "CInterpreter"]
+	path = CInterpreter
+	url = git@github.com:SKantar/CInterpreter.git
diff --git a/CInterpreter b/CInterpreter
new file mode 160000
index 0000000..7a5954d
--- /dev/null
+++ b/CInterpreter
@@ -0,0 +1 @@
+Subproject commit 7a5954dc6383a3c3219bc75c009dde1b2422ec29
diff --git a/dwarf_handler.py b/dwarf_handler.py
index 01bd536..756a693 100644
--- 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 = []