From: Vladimír Vondruš <mosra@centrum.cz>
Date: Sun, 7 Jul 2019 20:12:13 +0000 (+0200)
Subject: Doc++
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=a0e4de8657fc0c9cfcd377f1a3628efd8fa59283;p=blog.git

Doc++
---

diff --git a/documentation/doxygen.py b/documentation/doxygen.py
index c765f430..82b78735 100755
--- a/documentation/doxygen.py
+++ b/documentation/doxygen.py
@@ -3811,8 +3811,8 @@ def run(doxyfile, templates=default_templates, wildcard=default_wildcard, index_
                     f.write(rendered.encode('utf-8'))
                     # Add back a trailing newline so we don't need to bother
                     # with patching test files to include a trailing newline to
-                    # make Git happy
-                    # TODO could keep_trailing_newline fix this better?
+                    # make Git happy. Can't use keep_trailing_newline because
+                    # that'd add it also for nested templates :(
                     f.write(b'\n')
         else:
             parsed = parse_xml(state, file)
@@ -3829,8 +3829,8 @@ def run(doxyfile, templates=default_templates, wildcard=default_wildcard, index_
                 f.write(rendered.encode('utf-8'))
                 # Add back a trailing newline so we don't need to bother with
                 # patching test files to include a trailing newline to make Git
-                # happy
-                # TODO could keep_trailing_newline fix this better?
+                # happy. Can't use keep_trailing_newline because that'd add it
+                # also for nested templates :(
                 f.write(b'\n')
 
     # Empty index page in case no mainpage documentation was provided so
@@ -3854,8 +3854,8 @@ def run(doxyfile, templates=default_templates, wildcard=default_wildcard, index_
             f.write(rendered.encode('utf-8'))
             # Add back a trailing newline so we don't need to bother with
             # patching test files to include a trailing newline to make Git
-            # happy
-            # TODO could keep_trailing_newline fix this better?
+            # happy. Can't use keep_trailing_newline because that'd add it
+            # also for nested templates :(
             f.write(b'\n')
 
     if not state.doxyfile['M_SEARCH_DISABLED']:
@@ -3881,8 +3881,8 @@ def run(doxyfile, templates=default_templates, wildcard=default_wildcard, index_
                 f.write(rendered.encode('utf-8'))
                 # Add back a trailing newline so we don't need to bother with
                 # patching test files to include a trailing newline to make Git
-                # happy
-                # TODO could keep_trailing_newline fix this better?
+                # happy. Can't use keep_trailing_newline because that'd add it
+                # also for nested templates :(
                 f.write(b'\n')
 
     # Copy all referenced files
diff --git a/documentation/python.py b/documentation/python.py
index acf2b65f..29121f32 100755
--- a/documentation/python.py
+++ b/documentation/python.py
@@ -356,8 +356,8 @@ def render(config, template: str, page, env: jinja2.Environment):
         f.write(rendered.encode('utf-8'))
         # Add back a trailing newline so we don't need to bother with
         # patching test files to include a trailing newline to make Git
-        # happy
-        # TODO could keep_trailing_newline fix this better?
+        # happy. Can't use keep_trailing_newline because that'd add it
+        # also for nested templates :(
         f.write(b'\n')
 
 def extract_module_doc(state: State, path: List[str], module):
@@ -1179,8 +1179,8 @@ def run(basedir, config, templates):
             f.write(rendered.encode('utf-8'))
             # Add back a trailing newline so we don't need to bother with
             # patching test files to include a trailing newline to make Git
-            # happy
-            # TODO could keep_trailing_newline fix this better?
+            # happy. Can't use keep_trailing_newline because that'd add it
+            # also for nested templates :(
             f.write(b'\n')
 
     # Create index.html if it was not provided by the user