streams/util/Doxyfile

INPUT = README.md index.php boot.php include/ install/ util/ view/ src/
RECURSIVE = YES
PROJECT_NAME = "Streams"
PROJECT_LOGO = images/streams-64.png
EXCLUDE = .htconfig.php cache/ library/ doc/ store/ vendor/ .git/ util/generate-hooks-index/
EXCLUDE_PATTERNS = *smarty3* *strings.php *.out *test*
OUTPUT_DIRECTORY = ./
GENERATE_HTML = YES
HTML_OUTPUT = streams/
HTML_FILE_EXTENSION = .html
GENERATE_LATEX = NO
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
GENERATE_TODOLIST = YES
USE_MDFILE_AS_MAINPAGE = README.md
REFERENCED_BY_RELATION = YES
GENERATE_TREEVIEW = YES
HTML_FOOTER = util/Doxygen.footer
ALIASES += "license=@par License:\n"
ALIASES += "fixme=\xrefitem fixme \"Fixme\" \"Fixme List\""
ALIASES += "FIXME=\fixme"
ALIASES += "TODO=\todo"
ALIASES += "BUG=\bug"
ALIASES += "hooks=\xrefitem hooks \"Hooks\" \"Hooks List\""
ALIASES += "HOOKS=\hooks"
# Output
QUIET = YES
WARNINGS = YES
# Dot tool config
HAVE_DOT = YES
DOT_IMAGE_FORMAT = svg
INTERACTIVE_SVG = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
# fix @var (https://bugzilla.gnome.org/show_bug.cgi?id=626105)
#INPUT_FILTER = "sed -e 's/@var\s/@see /'"
INPUT_FILTER = "php util/Doxygen_phpvarfilter.php"
rename Code to src 2024-03-13 05:21:03 +00:00			`INPUT = README.md index.php boot.php include/ install/ util/ view/ src/`
initial doco 2013-02-26 23:49:37 +00:00			`RECURSIVE = YES`
code cleanup continued 2022-02-24 21:00:41 +00:00			`PROJECT_NAME = "Streams"`
			`PROJECT_LOGO = images/streams-64.png`
revive doxygen documentation 2023-09-03 10:58:10 +00:00			`EXCLUDE = .htconfig.php cache/ library/ doc/ store/ vendor/ .git/ util/generate-hooks-index/`
initial doco 2013-02-26 23:49:37 +00:00			`EXCLUDE_PATTERNS = smarty3 strings.php .out test`
revive doxygen documentation 2023-09-03 10:58:10 +00:00			`OUTPUT_DIRECTORY = ./`
doxygen gets tripped up by 'if (! function_exists' - but this construct no longer has value anyway. 2013-02-26 02:35:20 +00:00			`GENERATE_HTML = YES`
revive doxygen documentation 2023-09-03 10:58:10 +00:00			`HTML_OUTPUT = streams/`
doxygen gets tripped up by 'if (! function_exists' - but this construct no longer has value anyway. 2013-02-26 02:35:20 +00:00			`HTML_FILE_EXTENSION = .html`
			`GENERATE_LATEX = NO`
initial doco 2013-02-26 23:49:37 +00:00			`EXTRACT_ALL = YES`
			`EXTRACT_PRIVATE = YES`
			`GENERATE_TODOLIST = YES`
Correcting reported Doxygen syntax warnings. Fixed wrong Doxygen syntax and add some of the available FIXME to Doxygen documentation. Updated Doxygen configuration to add also all capital letter tags. Adding some more Doxygen documentation. 2015-03-21 23:06:08 +00:00			`USE_MDFILE_AS_MAINPAGE = README.md`
initial doco 2013-02-26 23:49:37 +00:00			`REFERENCED_BY_RELATION = YES`
remove date on the footer 2013-02-27 03:01:56 +00:00			`GENERATE_TREEVIEW = YES`
			`HTML_FOOTER = util/Doxygen.footer`
Extend Doxygen configuration a bit to display more. Add view of \license information in Doxygen information and add an overview page for \fixme which is used in source code. We have Bug List, Fixme List, Todo List and Deprecated List. Do we have some other tags we use that we could collect and display? 2015-03-21 00:50:08 +00:00			`ALIASES += "license=@par License:\n"`
			`ALIASES += "fixme=\xrefitem fixme \"Fixme\" \"Fixme List\""`
Correcting reported Doxygen syntax warnings. Fixed wrong Doxygen syntax and add some of the available FIXME to Doxygen documentation. Updated Doxygen configuration to add also all capital letter tags. Adding some more Doxygen documentation. 2015-03-21 23:06:08 +00:00			`ALIASES += "FIXME=\fixme"`
			`ALIASES += "TODO=\todo"`
			`ALIASES += "BUG=\bug"`
[TASK] Update Doxyfile and fix Doxygen errors. Updated Doxyfile to include new folders. Add a list for @hooks tags. Fixed some parsing problems for Doxygen. 2016-10-01 22:41:25 +00:00			`ALIASES += "hooks=\xrefitem hooks \"Hooks\" \"Hooks List\""`
			`ALIASES += "HOOKS=\hooks"`
:green_heart: Update Travis CI's Doxygen. Travis CI has Doxygen 1.7. We need 1.8 to generate our API documentation. Get a static version and use it. Always build API Documentation, but changed Doxygen configuration to only print out errors in the documentation generation, so these can be reviewed. 2016-11-06 20:31:02 +00:00			`# Output`
			`QUIET = YES`
			`WARNINGS = YES`
			`# Dot tool config`
			`HAVE_DOT = YES`
			`DOT_IMAGE_FORMAT = svg`
			`INTERACTIVE_SVG = YES`
			`CLASS_GRAPH = YES`
			`COLLABORATION_GRAPH = NO`
:bulb: Add Doxygen fix for @var member variable documentation. Add an input filter to Doxygen to parse @var class member variable documentation, so it is bit more compatible how anybody else interpretes it. 2017-05-03 22:43:55 +00:00			`# fix @var (https://bugzilla.gnome.org/show_bug.cgi?id=626105)`
			`#INPUT_FILTER = "sed -e 's/@var\s/@see /'"`
			`INPUT_FILTER = "php util/Doxygen_phpvarfilter.php"`