Skip to content

Commit

Permalink
Add quotes around Doxygen configuration values (flutter#45087)
Browse files Browse the repository at this point in the history
## Description

Add quotes are the Doxygen configuration values that may have spaces, since otherwise Doxygen strips them.
  • Loading branch information
gspencergoog authored Aug 25, 2023
1 parent 33fca02 commit 7e6b726
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/Doxyfile.template
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = @@PROJECT_NAME@@
PROJECT_NAME = "@@PROJECT_NAME@@"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand All @@ -74,7 +74,7 @@ PROJECT_LOGO = ./docs/flutter_logo.png
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = @@OUTPUT_DIRECTORY@@
OUTPUT_DIRECTORY = "@@OUTPUT_DIRECTORY@@"

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
Expand Down Expand Up @@ -938,7 +938,7 @@ WARN_LINE_FORMAT = "at line $line of file $file"
# specified the warning and error messages are written to standard output
# (stdout).

WARN_LOGFILE = @@LOG_FILE@@
WARN_LOGFILE = "@@LOG_FILE@@"

#---------------------------------------------------------------------------
# Configuration options related to the input files
Expand Down Expand Up @@ -1437,7 +1437,7 @@ GENERATE_DOCSET = YES
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.

DOCSET_FEEDNAME = @@DOCSET_FEEDNAME@@
DOCSET_FEEDNAME = "@@DOCSET_FEEDNAME@@"

# This tag determines the URL of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
Expand Down
4 changes: 3 additions & 1 deletion tools/gen_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ def generate_doxyfile(section, output_dir, log_file, doxy_file):
doxyfile = open('docs/Doxyfile.template', 'r').read()
doxyfile = doxyfile.replace('@@OUTPUT_DIRECTORY@@', output_dir)
doxyfile = doxyfile.replace('@@LOG_FILE@@', log_file)
doxyfile = doxyfile.replace('@@INPUT_DIRECTORIES@@', ' '.join(section.inputs))
doxyfile = doxyfile.replace(
'@@INPUT_DIRECTORIES@@', '"{}"'.format('" "'.join(section.inputs))
)
doxyfile = doxyfile.replace(
'@@PROJECT_NAME@@', 'Flutter {}'.format(section.title)
)
Expand Down

0 comments on commit 7e6b726

Please sign in to comment.