From: Hypolite Petovan Date: Thu, 29 Nov 2018 04:09:35 +0000 (-0500) Subject: Move Doxyfile to base directory X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=c3c7c50dc525653fee16a92a5e14106a4b83249c;p=friendica.git Move Doxyfile to base directory --- diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000000..a1676eba7a --- /dev/null +++ b/Doxyfile @@ -0,0 +1,23 @@ +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/ 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/ +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 +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\"" 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 Doxygen (included in most distributions).
-$ doxygen util/Doxyfile
+$ doxygen Doxyfile
 

back diff --git a/util/Doxyfile b/util/Doxyfile deleted file mode 100644 index aef2307927..0000000000 --- a/util/Doxyfile +++ /dev/null @@ -1,24 +0,0 @@ -INPUT = README.md index.php boot.php testargs.php update.php mod/ object/ include/ js/ util/ view/ src/ version.inc -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* -OUTPUT_DIRECTORY = doc -GENERATE_HTML = YES -HTML_OUTPUT = html/ -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\"" 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 @@ - - - -