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

[friendica.git] / doc / Developers-Intro.md

diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md
index 6ae5cb5cd0bc8cb7b5e5ea4a8a4eb5a47939427d..67cc932a2a5be83d82e439226a65e16147cc833d 100644 (file)
--- 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](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
 
@@ -69,7 +84,7 @@ Do not worry about cross-posting.
 
 ###Client software
 There are free software clients that do somehow work with Friendica but most of them need love and maintenance.
-Also, they were mostly made for other platforms using the StatusNet API.
+Also, they were mostly made for other platforms using the GNU Social API.
 This means they lack the features that are really specific to Friendica.
 Popular clients you might want to have a look at are: