]> git.mxchange.org Git - friendica.git/commitdiff
Move Doxyfile to base directory
authorHypolite Petovan <hypolite@mrpetovan.com>
Thu, 29 Nov 2018 04:09:35 +0000 (23:09 -0500)
committerHypolite Petovan <hypolite@mrpetovan.com>
Thu, 29 Nov 2018 04:09:35 +0000 (23:09 -0500)
Doxyfile [new file with mode: 0644]
doc/Developers-Intro.md
doc/html/index.php
util/Doxyfile [deleted file]
util/Doxygen.footer [deleted file]

diff --git a/Doxyfile b/Doxyfile
new file mode 100644 (file)
index 0000000..a1676eb
--- /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\""
index 228d2fcf03836cccc35321c17b53257dd9919379..d7f3f81fe6eddb237d82ba2b435c567085316268 100644 (file)
@@ -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.
index 2e1b4277cfba51b2a463049c003285b9e5c63ed8..ab8375907ae8f9e8e141bb2fa7d69b09488dcf1b 100644 (file)
@@ -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/Doxyfile b/util/Doxyfile
deleted file mode 100644 (file)
index aef2307..0000000
+++ /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 (file)
index fd40910..0000000
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-