X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2FDevelopers-Intro.md;h=10bbd5632afa008d2b860a7a9e325020394d4540;hb=f76a24607c3c6b4debf7c2eaf3c957e4312f95c9;hp=ff8c3c54c27038499dcf7286d09e9586a6dfd9da;hpb=4b6afbf6814acde5151edc74f0b6cf1fd7685432;p=friendica.git diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index ff8c3c54c2..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! @@ -54,6 +67,8 @@ Have a look at our [issue tracker](https://github.com/friendica/friendica) on gi * Try to reproduce a bug that needs more inquries and write down what you find out. * If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed. * Fix a bug if you can. Please make the pull request against the *develop* branch of the repository. + * There is a *Junior Job* label for issues we think might be a good point to start with. + But you don't have to limit yourself to those issues. ###Web interface