added a brief note how to generate docs with Doxygen to the developers intro page
This commit is contained in:
parent
c3ae4a03bb
commit
e855043439
|
@ -47,6 +47,19 @@ We can't promise we have the right skills in the group but we'll try.
|
||||||
Programming
|
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
|
###Issues
|
||||||
|
|
||||||
Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!
|
Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!
|
||||||
|
|
Loading…
Reference in a new issue