diff options
| author | Harald Eilertsen <haraldei@anduin.net> | 2024-02-27 11:08:18 +0100 |
|---|---|---|
| committer | Harald Eilertsen <haraldei@anduin.net> | 2024-02-27 11:08:18 +0100 |
| commit | 18abfb11ef56e8bb4ee25b57b1a0bcd2f9495d3f (patch) | |
| tree | cf2c2d08bf9d4a204cbaaf5d9e6473170937fa08 | |
| parent | c639704f3c1a34bdd8bccd0e6ce37f3eef3921d7 (diff) | |
| download | volse-hubzilla-18abfb11ef56e8bb4ee25b57b1a0bcd2f9495d3f.tar.gz volse-hubzilla-18abfb11ef56e8bb4ee25b57b1a0bcd2f9495d3f.tar.bz2 volse-hubzilla-18abfb11ef56e8bb4ee25b57b1a0bcd2f9495d3f.zip | |
Update Doxygen config for generating online API docs
Enabled implicit brief descriptions (`JAVADOC_AUTOBRIEF`), and markdown
support (`MARKDOWN_SUPPORT`) for doc blocks. This means that we no
longer need to explicitly inclufe a `@brief` tag in the doc block, the
first full sentence will be regarded as the brief documentation if it's
not explicitly given. Also we can use Markdown formatting in the
comments, which is a bit nicer than the native Doxygen tags.
I also disabled the Doxygen_phpvarfilter, but leave it commented out. It
should not be needed anymore unless somebody is using an ancient version
of doxygen. (Don't do that!)
I also changed the heading a bit, removed "The" from "The Hubzilla", and
added a tagline. Feel free to revise to whatever conforms to the project
norms.
| -rwxr-xr-x | util/Doxyfile | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/util/Doxyfile b/util/Doxyfile index 14464df81..10c43e46d 100755 --- a/util/Doxyfile +++ b/util/Doxyfile @@ -1,6 +1,7 @@ INPUT = README.md index.php boot.php include/ install/ util/ view/ Zotlabs/ RECURSIVE = YES -PROJECT_NAME = "The Hubzilla" +PROJECT_NAME = "Hubzilla" +PROJECT_BRIEF = "A powerful, privacy oriented fediverse CMS." PROJECT_LOGO = images/hz-64.png IMAGE_PATH = images/ EXCLUDE = .htconfig.php library/ doc/ store/ vendor/ .git/ util/zotsh/easywebdav/ util/generate-hooks-index/ @@ -36,4 +37,6 @@ COLLABORATION_GRAPH = NO # fix @var (https://bugzilla.gnome.org/show_bug.cgi?id=626105) # Should be obsolete with doxygen >= 1.8.15 #INPUT_FILTER = "sed -e 's/@var\s/@see /'" -INPUT_FILTER = "php util/Doxygen_phpvarfilter.php" +#INPUT_FILTER = "php util/Doxygen_phpvarfilter.php" +JAVADOC_AUTOBRIEF = YES +MARKDOWN_SUPPORT = YES |