Browse Source

added code reference to docs

rabuzarus 3 years ago
parent
commit
b31c602e9b
6 changed files with 46 additions and 1 deletions
  1. 1
    0
      doc/Home.md
  2. 1
    0
      doc/de/Home.md
  3. 16
    0
      doc/html/index.php
  4. 1
    1
      mod/help.php
  5. 23
    0
      util/Doxyfile
  6. 4
    0
      util/Doxygen.footer

+ 1
- 0
doc/Home.md View File

@@ -46,6 +46,7 @@ Friendica Documentation and Resources
46 46
 * [Plugin Development](help/Plugins)
47 47
 * [Theme Development](help/themes)
48 48
 * [Smarty 3 Templates](help/smarty3-templates)
49
+* [Code - Reference(Doxygen generated - sets cookies)](doc/html/)
49 50
 
50 51
 **External Resources**
51 52
 

+ 1
- 0
doc/de/Home.md View File

@@ -50,6 +50,7 @@ Friendica - Dokumentation und Ressourcen
50 50
 * [Plugin Development](help/Plugins)
51 51
 * [Theme Development](help/themes)
52 52
 * [Smarty 3 Templates](help/smarty3-templates)
53
+* [Code-Referenz (mit doxygen generiert - setzt Cookies)](doc/html/)
53 54
 
54 55
 **Externe Ressourcen**
55 56
 

+ 16
- 0
doc/html/index.php View File

@@ -0,0 +1,16 @@
1
+<!DOCTYPE html>
2
+<html>
3
+<head>
4
+	<title>$Projectname Doxygen API Documentation</title>
5
+</head>
6
+<body>
7
+<h1>$Projectname Doxygen API Documentation not rendered</h1>
8
+
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
+<pre>
11
+$ doxygen util/Doxyfile
12
+</pre>
13
+<br>
14
+<a href="javascript:history.back()">back</a>
15
+</body>
16
+</html>

+ 1
- 1
mod/help.php View File

@@ -50,4 +50,4 @@ function help_content(&$a) {
50 50
 	$html = "<style>.md_warning { padding: 1em; border: #ff0000 solid 2px; background-color: #f9a3a3; color: #ffffff;</style>".$html;
51 51
 	return $html;
52 52
 
53
-}
53
+}

+ 23
- 0
util/Doxyfile View File

@@ -0,0 +1,23 @@
1
+INPUT = README.md index.php boot.php testargs.php update.php mod/ object/ include/ js/ util/ view/ version.inc
2
+RECURSIVE = YES
3
+PROJECT_NAME = "Friendica"
4
+PROJECT_LOGO = images/friendica-64.jpg
5
+EXCLUDE = .htconfig.php library/ doc/ .git/ log/ util/zotsh/easywebdav/
6
+EXCLUDE_PATTERNS = *smarty3* *strings.php *.out *test*
7
+OUTPUT_DIRECTORY = doc
8
+GENERATE_HTML = YES
9
+HTML_OUTPUT = html/
10
+HTML_FILE_EXTENSION = .html
11
+GENERATE_LATEX = NO
12
+EXTRACT_ALL = YES
13
+EXTRACT_PRIVATE = YES
14
+GENERATE_TODOLIST = YES
15
+USE_MDFILE_AS_MAINPAGE = README.md
16
+REFERENCED_BY_RELATION = YES
17
+GENERATE_TREEVIEW = YES
18
+HTML_FOOTER = util/Doxygen.footer
19
+ALIASES += "license=@par License:\n"
20
+ALIASES += "fixme=\xrefitem fixme \"Fixme\" \"Fixme List\""
21
+ALIASES += "FIXME=\fixme"
22
+ALIASES += "TODO=\todo"
23
+ALIASES += "BUG=\bug"

+ 4
- 0
util/Doxygen.footer View File

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

Loading…
Cancel
Save