]> git.mxchange.org Git - friendica.git/commitdiff
added code reference to docs
authorrabuzarus <>
Wed, 2 Dec 2015 23:06:11 +0000 (00:06 +0100)
committerrabuzarus <>
Wed, 2 Dec 2015 23:06:11 +0000 (00:06 +0100)
doc/Home.md
doc/de/Home.md
doc/html/index.php [new file with mode: 0644]
mod/help.php
util/Doxyfile [new file with mode: 0644]
util/Doxygen.footer [new file with mode: 0644]

index cd8752c1effa808c027ba58069eeba888fbb0a0b..b37c76417c8553446b2095853b1ec1843b8c90c8 100644 (file)
@@ -46,6 +46,7 @@ Friendica Documentation and Resources
 * [Plugin Development](help/Plugins)
 * [Theme Development](help/themes)
 * [Smarty 3 Templates](help/smarty3-templates)
+* [Code - Reference(Doxygen generated - sets cookies)](doc/html/)
 
 **External Resources**
 
index 2a9ea091ed56c3ea30802086184216a40aa113b6..44ebfc02852d3b10057983fea61e0a3590aa41eb 100644 (file)
@@ -50,6 +50,7 @@ Friendica - Dokumentation und Ressourcen
 * [Plugin Development](help/Plugins)
 * [Theme Development](help/themes)
 * [Smarty 3 Templates](help/smarty3-templates)
+* [Code-Referenz (mit doxygen generiert - setzt Cookies)](doc/html/)
 
 **Externe Ressourcen**
 
diff --git a/doc/html/index.php b/doc/html/index.php
new file mode 100644 (file)
index 0000000..2e1b427
--- /dev/null
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+       <title>$Projectname Doxygen API Documentation</title>
+</head>
+<body>
+<h1>$Projectname Doxygen API Documentation not rendered</h1>
+
+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
+</pre>
+<br>
+<a href="javascript:history.back()">back</a>
+</body>
+</html>
index 6d8fbb1842295fd67814de01657ecd310c6d5936..6b8cb3821a4ae65283caef25abecb2842db39b13 100644 (file)
@@ -50,4 +50,4 @@ function help_content(&$a) {
        $html = "<style>.md_warning { padding: 1em; border: #ff0000 solid 2px; background-color: #f9a3a3; color: #ffffff;</style>".$html;
        return $html;
 
-}
+}
\ No newline at end of file
diff --git a/util/Doxyfile b/util/Doxyfile
new file mode 100644 (file)
index 0000000..c009290
--- /dev/null
@@ -0,0 +1,23 @@
+INPUT = README.md index.php boot.php testargs.php update.php mod/ object/ include/ js/ util/ view/ version.inc
+RECURSIVE = YES
+PROJECT_NAME = "Friendica"
+PROJECT_LOGO = images/friendica-64.jpg
+EXCLUDE = .htconfig.php library/ doc/ .git/ log/ util/zotsh/easywebdav/
+EXCLUDE_PATTERNS = *smarty3* *strings.php *.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"
diff --git a/util/Doxygen.footer b/util/Doxygen.footer
new file mode 100644 (file)
index 0000000..fd40910
--- /dev/null
@@ -0,0 +1,4 @@
+
+
+
+