]> git.mxchange.org Git - friendica.git/commitdiff
added a brief note how to generate docs with Doxygen to the developers intro page
authorTobias Diekershoff <tobias.diekershoff@gmx.net>
Fri, 25 Dec 2015 11:23:57 +0000 (12:23 +0100)
committerTobias Diekershoff <tobias.diekershoff@gmx.net>
Fri, 25 Dec 2015 11:23:57 +0000 (12:23 +0100)
doc/Developers-Intro.md

index 7e5caae2b3274975d3340a55dbb8a114859dc950..67cc932a2a5be83d82e439226a65e16147cc833d 100644 (file)
@@ -47,6 +47,19 @@ We can't promise we have the right skills in the group but we'll try.
 Programming
 ---
 
+###Code documentation
+
+If you are interested in having the documentation of the Friendica code outside of the code files, you can use [Doxygen](doxygen.org) to generate it.
+The configuration file for Doxygen is located in the ```util``` directory of the project sources.
+Run
+
+    $> doxygen util/Doxyfile
+
+to generate the files which will be located in the ```doc/html``` subdirectory in the Friendica directory.
+You can browse these files with any browser.
+
+If you find missing documentation, don't hestitate to contact us and write it down to enhance the code documentation.
+
 ###Issues
 
 Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!