Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2024-12-23 23:20:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #2202 from tobiasd/20151225-doxygen

Browse source 
brief instruction on how to use Doxygen
This commit is contained in:
Michael Vogel 2015-12-26 07:27:39 +01:00
commit fa88bdf2e2
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/Developers-Intro.md
View 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](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!