From b31c602e9b8fa580ee0e6a8afb9de1c761bf122c Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Thu, 3 Dec 2015 00:06:11 +0100 Subject: [PATCH] added code reference to docs --- doc/Home.md | 1 + doc/de/Home.md | 1 + doc/html/index.php | 16 ++++++++++++++++ mod/help.php | 2 +- util/Doxyfile | 23 +++++++++++++++++++++++ util/Doxygen.footer | 4 ++++ 6 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 doc/html/index.php create mode 100644 util/Doxyfile create mode 100644 util/Doxygen.footer diff --git a/doc/Home.md b/doc/Home.md index cd8752c1ef..b37c76417c 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -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** diff --git a/doc/de/Home.md b/doc/de/Home.md index 2a9ea091ed..44ebfc0285 100644 --- a/doc/de/Home.md +++ b/doc/de/Home.md @@ -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 index 0000000000..2e1b4277cf --- /dev/null +++ b/doc/html/index.php @@ -0,0 +1,16 @@ + + + + $Projectname Doxygen API Documentation + + +

$Projectname Doxygen API Documentation not rendered

+ +To get the Doxygen API Documentation you must render it with the program Doxygen (included in most distributions). +
+$ doxygen util/Doxyfile
+
+
+back + + diff --git a/mod/help.php b/mod/help.php index 6d8fbb1842..6b8cb3821a 100644 --- a/mod/help.php +++ b/mod/help.php @@ -50,4 +50,4 @@ function help_content(&$a) { $html = "".$html; return $html; -} +} \ No newline at end of file diff --git a/util/Doxyfile b/util/Doxyfile new file mode 100644 index 0000000000..c009290312 --- /dev/null +++ b/util/Doxyfile @@ -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 index 0000000000..fd40910d9e --- /dev/null +++ b/util/Doxygen.footer @@ -0,0 +1,4 @@ + + + +