Added docstring to gen_doxyfile mako template

10 years ago · f6bf2d75c8
parent eaee2bcb32
commit f6bf2d75c8
1 changed files with 7 additions and 0 deletions
--- a/templates/tools/doxygen/Doxyfile.include
+++ b/templates/tools/doxygen/Doxyfile.include
@ -1,3 +1,10 @@
+## Populates "targets" for all names in the collection "libnames" that are
+## part of "collection".
+##
+## Note that "packagename" and "internal" while not used
+## in the function itself are referenced in the template.
+## When "internal" is true, documentation for non-public headers
+## and sources is also taken as input to Doxygen (see INPUT).
 <%def name="gen_doxyfile(libnames, packagename, collection, internal)">
 <%
  import itertools