[gtk-doc] mkhtml2: planning comments

[Stefan Sauer <stefkost src gnome org>]

commit 77aed67a052db2a6aca512fbcf3997be32d45233
Author: Stefan Sauer <ensonic users sf net>
Date:   Fri Mar 2 08:15:27 2018 +0100

    mkhtml2: planning comments

 gtkdoc/mkhtml2.py |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
---
diff --git a/gtkdoc/mkhtml2.py b/gtkdoc/mkhtml2.py
index 7699812..1dd8d94 100644
--- a/gtkdoc/mkhtml2.py
+++ b/gtkdoc/mkhtml2.py
@@ -862,6 +862,8 @@ def main(index_file):
     # tree.write(out_file)
 
     # TODO: rename to 'html' later on
+    # - right now in mkhtml, the dir is created by the Makefile and mkhtml
+    #   outputs into the working directory
     out_dir = os.path.join(dir_name, 'db2html')
     try:
         os.mkdir(out_dir)
@@ -869,11 +871,11 @@ def main(index_file):
         if e.errno != errno.EEXIST:
             raise
 
-    # We need multiple passes:
+    # We do multiple passes:
     # 1) recursively walk the tree and chunk it into a python tree so that we
     #   can generate navigation and link tags.
-    #   also collect all 'id' attributes on the way and build map of
-    #   id:rel-link (in fixxref is is Links[])
+    # TODO: also collect all 'id' attributes on the way and build map of
+    #   id:rel-link (in fixxref it is called Links[])
     files = chunk(tree.getroot())
     # 2) iterate the tree and output files
     # TODO: use multiprocessing