Browse Source

added a brief note how to generate docs with Doxygen to the developers intro page

tags/3.5
Tobias Diekershoff 4 years ago
parent
commit
e855043439
1 changed files with 13 additions and 0 deletions
  1. +13
    -0
      doc/Developers-Intro.md

+ 13
- 0
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](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!


Loading…
Cancel
Save