From: Tobias Diekershoff Date: Fri, 25 Dec 2015 11:23:57 +0000 (+0100) Subject: added a brief note how to generate docs with Doxygen to the developers intro page X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=e8550434390f4c1743bf6c452c404071054033d7;p=friendica.git added a brief note how to generate docs with Doxygen to the developers intro page --- diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index 7e5caae2b3..67cc932a2a 100644 --- a/doc/Developers-Intro.md +++ b/doc/Developers-Intro.md @@ -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!