Merge pull request #2202 from tobiasd/20151225-doxygen

brief instruction on how to use Doxygen
2022.09-rc
Michael Vogel 2015-12-26 07:27:39 +01:00
commit fa88bdf2e2
1 zmienionych plików z 13 dodań i 0 usunięć

Wyświetl plik

@ -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!