Move Doxyfile to base directory
This commit is contained in:
parent
c0b3b73c88
commit
c3c7c50dc5
4 changed files with 6 additions and 11 deletions
|
@ -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"
|
|
@ -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.
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -1,4 +0,0 @@
|
|||
|
||||
|
||||
|
||||
|
Loading…
Reference in a new issue