X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2FDevelopers-Intro.md;h=10bbd5632afa008d2b860a7a9e325020394d4540;hb=f76a24607c3c6b4debf7c2eaf3c957e4312f95c9;hp=7e5caae2b3274975d3340a55dbb8a114859dc950;hpb=59559e74520ad3b2a3f121b469debdc4fbde1bef;p=friendica.git diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index 7e5caae2b3..10bbd5632a 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](http://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!