From c3c7c50dc525653fee16a92a5e14106a4b83249c Mon Sep 17 00:00:00 2001 From: Hypolite Petovan <hypolite@mrpetovan.com> Date: Wed, 28 Nov 2018 23:09:35 -0500 Subject: [PATCH] Move Doxyfile to base directory --- util/Doxyfile => Doxyfile | 7 +++---- doc/Developers-Intro.md | 4 ++-- doc/html/index.php | 2 +- util/Doxygen.footer | 4 ---- 4 files changed, 6 insertions(+), 11 deletions(-) rename util/Doxyfile => Doxyfile (62%) delete mode 100644 util/Doxygen.footer diff --git a/util/Doxyfile b/Doxyfile similarity index 62% rename from util/Doxyfile rename to Doxyfile index aef2307927..a1676eba7a 100644 --- a/util/Doxyfile +++ b/Doxyfile @@ -1,9 +1,9 @@ -INPUT = README.md index.php boot.php testargs.php update.php mod/ object/ include/ js/ util/ view/ src/ version.inc +INPUT = README.md index.php boot.php update.php bin/ mod/ include/ view/ src/ VERSION RECURSIVE = YES PROJECT_NAME = "Friendica" PROJECT_LOGO = images/friendica-64.jpg -EXCLUDE = .htconfig.php config/ library/ doc/ .git/ log/ util/zotsh/easywebdav/ addon/ report/ privacy_image_cache/ photo/ proxy/ local/ -EXCLUDE_PATTERNS = *smarty3* *strings.php*.log *.out *test* +EXCLUDE = .htconfig.php config/ library/ doc/ .git/ log/ addon/ report/ privacy_image_cache/ photo/ proxy/ local/ +EXCLUDE_PATTERNS = *smarty3* strings.php *.log *.out *test* OUTPUT_DIRECTORY = doc GENERATE_HTML = YES HTML_OUTPUT = html/ @@ -15,7 +15,6 @@ 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" diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index 228d2fcf03..d7f3f81fe6 100644 --- a/doc/Developers-Intro.md +++ b/doc/Developers-Intro.md @@ -111,10 +111,10 @@ If the command-line tools `diff` and `patch` are unavailabe for you, `phpcbf` ca ### Code documentation If you are interested in having the documentation of the Friendica code outside of the code files, you can use [Doxygen](http://doxygen.org) to generate it. -The configuration file for Doxygen is located in the `util` directory of the project sources. +The configuration file for Doxygen is located in the base directory of the project sources. Run - $> doxygen util/Doxyfile + $> doxygen Doxyfile to generate the files which will be located in the `doc/html` subdirectory in the Friendica directory. You can browse these files with any browser. diff --git a/doc/html/index.php b/doc/html/index.php index 2e1b4277cf..ab8375907a 100644 --- a/doc/html/index.php +++ b/doc/html/index.php @@ -8,7 +8,7 @@ To get the Doxygen API Documentation you must render it with the program <a href="http://www.doxygen.org">Doxygen</a> (included in most distributions). <pre> -$ doxygen util/Doxyfile +$ doxygen Doxyfile </pre> <br> <a href="javascript:history.back()">back</a> diff --git a/util/Doxygen.footer b/util/Doxygen.footer deleted file mode 100644 index fd40910d9e..0000000000 --- a/util/Doxygen.footer +++ /dev/null @@ -1,4 +0,0 @@ - - - -