From b31c602e9b8fa580ee0e6a8afb9de1c761bf122c Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Thu, 3 Dec 2015 00:06:11 +0100
Subject: [PATCH 1/5] 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 cd8752c1e..b37c76417 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 2a9ea091e..44ebfc028 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 000000000..2e1b4277c
--- /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 6d8fbb184..6b8cb3821 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 000000000..c00929031
--- /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 000000000..fd40910d9
--- /dev/null
+++ b/util/Doxygen.footer
@@ -0,0 +1,4 @@
+
+
+
+
From 8522446891d0f13c9606de084332820968fb3e16 Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Thu, 3 Dec 2015 00:11:18 +0100
Subject: [PATCH 2/5] little cleanup: insert new line at the end
---
mod/help.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/mod/help.php b/mod/help.php
index 6b8cb3821..6d8fbb184 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
+}
From 76bb3f66737df48f012531eeb01dd608128e9c4f Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Thu, 3 Dec 2015 16:17:25 +0100
Subject: [PATCH 3/5] doxygen: exclude some more folders
---
.gitignore | 9 +++++++++
util/Doxyfile | 4 ++--
view/theme/boheme | 1 +
3 files changed, 12 insertions(+), 2 deletions(-)
create mode 160000 view/theme/boheme
diff --git a/.gitignore b/.gitignore
index 3c0570c67..0f644f483 100644
--- a/.gitignore
+++ b/.gitignore
@@ -42,3 +42,12 @@ nbproject
#ignore local folder
/local/
+
+.directory
+
+/view/theme/Friendiboot
+/view/theme/clean
+/view/theme/Viereinhalb
+/view/theme/suckerberg
+/view/theme/blog
+/view/theme/boehme
diff --git a/util/Doxyfile b/util/Doxyfile
index c00929031..4527c4ca6 100644
--- a/util/Doxyfile
+++ b/util/Doxyfile
@@ -2,8 +2,8 @@ INPUT = README.md index.php boot.php testargs.php update.php mod/ object/ includ
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*
+EXCLUDE = .htconfig.php library/ doc/ .git/ log/ util/zotsh/easywebdav/ 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/
diff --git a/view/theme/boheme b/view/theme/boheme
new file mode 160000
index 000000000..3009bdd2c
--- /dev/null
+++ b/view/theme/boheme
@@ -0,0 +1 @@
+Subproject commit 3009bdd2c2720d481028cb03671a5987160b8279
From b4213d0e9e0a5b530c7e39cdb26071e76d52aca6 Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Thu, 3 Dec 2015 17:30:34 +0100
Subject: [PATCH 4/5] doxygen: delete wrong commited file
---
view/theme/boheme | 1 -
1 file changed, 1 deletion(-)
delete mode 160000 view/theme/boheme
diff --git a/view/theme/boheme b/view/theme/boheme
deleted file mode 160000
index 3009bdd2c..000000000
--- a/view/theme/boheme
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 3009bdd2c2720d481028cb03671a5987160b8279
From 5ff9fbb0139916c73a7aaf1d3320d425612f01c8 Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Thu, 3 Dec 2015 21:22:13 +0100
Subject: [PATCH 5/5] doxygen: correct mistake - .gitignore shouldn't be
submitted
---
.gitignore | 9 ---------
1 file changed, 9 deletions(-)
diff --git a/.gitignore b/.gitignore
index 0f644f483..3c0570c67 100644
--- a/.gitignore
+++ b/.gitignore
@@ -42,12 +42,3 @@ nbproject
#ignore local folder
/local/
-
-.directory
-
-/view/theme/Friendiboot
-/view/theme/clean
-/view/theme/Viereinhalb
-/view/theme/suckerberg
-/view/theme/blog
-/view/theme/boehme