Browse Source

Move Doxyfile to base directory

Hypolite Petovan 2 months ago
parent
commit
c3c7c50dc5
4 changed files with 6 additions and 11 deletions
  1. 3
    4
      Doxyfile
  2. 2
    2
      doc/Developers-Intro.md
  3. 1
    1
      doc/html/index.php
  4. 0
    4
      util/Doxygen.footer

util/Doxyfile → Doxyfile View File

@@ -1,9 +1,9 @@
1
-INPUT = README.md index.php boot.php testargs.php update.php mod/ object/ include/ js/ util/ view/ src/ version.inc
1
+INPUT = README.md index.php boot.php update.php bin/ mod/ include/ view/ src/ VERSION
2 2
 RECURSIVE = YES
3 3
 PROJECT_NAME = "Friendica"
4 4
 PROJECT_LOGO = images/friendica-64.jpg
5
-EXCLUDE = .htconfig.php config/ library/ doc/ .git/ log/ util/zotsh/easywebdav/ addon/ report/ privacy_image_cache/ photo/ proxy/ local/
6
-EXCLUDE_PATTERNS = *smarty3* *strings.php*.log *.out *test*
5
+EXCLUDE = .htconfig.php config/ library/ doc/ .git/ log/ addon/ report/ privacy_image_cache/ photo/ proxy/ local/
6
+EXCLUDE_PATTERNS = *smarty3* strings.php *.log *.out *test*
7 7
 OUTPUT_DIRECTORY = doc
8 8
 GENERATE_HTML = YES
9 9
 HTML_OUTPUT = html/
@@ -15,7 +15,6 @@ GENERATE_TODOLIST = YES
15 15
 USE_MDFILE_AS_MAINPAGE = README.md
16 16
 REFERENCED_BY_RELATION = YES
17 17
 GENERATE_TREEVIEW = YES
18
-HTML_FOOTER = util/Doxygen.footer
19 18
 ALIASES += "license=@par License:\n"
20 19
 ALIASES += "fixme=\xrefitem fixme \"Fixme\" \"Fixme List\""
21 20
 ALIASES += "FIXME=\fixme"

+ 2
- 2
doc/Developers-Intro.md View File

@@ -111,10 +111,10 @@ If the command-line tools `diff` and `patch` are unavailabe for you, `phpcbf` ca
111 111
 ### Code documentation
112 112
 
113 113
 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.
114
-The configuration file for Doxygen is located in the `util` directory of the project sources.
114
+The configuration file for Doxygen is located in the base directory of the project sources.
115 115
 Run
116 116
 
117
-	$> doxygen util/Doxyfile
117
+	$> doxygen Doxyfile
118 118
 
119 119
 to generate the files which will be located in the `doc/html` subdirectory in the Friendica directory.
120 120
 You can browse these files with any browser.

+ 1
- 1
doc/html/index.php View File

@@ -8,7 +8,7 @@
8 8
 
9 9
 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).
10 10
 <pre>
11
-$ doxygen util/Doxyfile
11
+$ doxygen Doxyfile
12 12
 </pre>
13 13
 <br>
14 14
 <a href="javascript:history.back()">back</a>

+ 0
- 4
util/Doxygen.footer View File

@@ -1,4 +0,0 @@
1
-
2
-
3
-
4
-

Loading…
Cancel
Save