From 8afce61b4322fa643f1ae36aac25fbbc3d6a88f7 Mon Sep 17 00:00:00 2001 From: Adam Felizzi Date: Tue, 24 Apr 2018 15:13:07 +1000 Subject: [PATCH] manual: Updated comments Minor comment changes to the parse_doxygen_xml.py script. --- manual/tools/parse_doxygen_xml.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/manual/tools/parse_doxygen_xml.py b/manual/tools/parse_doxygen_xml.py index 63cdb0484..d1ac6ff0b 100755 --- a/manual/tools/parse_doxygen_xml.py +++ b/manual/tools/parse_doxygen_xml.py @@ -83,7 +83,7 @@ class Generator(object): return string def ref_format(self, refid, ref_dict): - """Lookup refid in ref_dict and output the latex for an apifunc ref""" + """Lookup refid in ref_dict and output the api function reference""" return "" def ref_to_format(self, para, ref_dict): @@ -283,7 +283,7 @@ class LatexGenerator(Generator): return "" def ref_format(self, refid, ref_dict): - """Lookup refid in ref_dict and output the latex for an apifunc ref""" + """Lookup refid in ref_dict and output the formatted latex reference""" ref = ref_dict[refid] return "\\apifunc{%(name)s}{%(label)s}" % ref @@ -375,7 +375,7 @@ class MarkdownGenerator(Generator): def ref_format(self, refid, ref_dict): """ - Lookup refid in ref_dict and output the Markdown for an api functions ref + Lookup refid in ref_dict and output the formatted Markdown reference Creates a Markdown link """ @@ -437,7 +437,7 @@ Type | Name | Description } def level_to_markdown(self, string): - """Converts the level to an corresponding markdown heading prefix""" + """Converts the level to a corresponding markdown heading prefix""" if string == "subsubsection": return "####"