README: add a section about API documentation

Doxygen and python documentation are briefly mentioned in the BINDINGS
section but there's no word about the core C API and automatically
generated man pages.

Add a separate section to the README file describing the process of
generating html doxygen output, python help strings and man pages for
gpio-tools.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

diff --git a/README b/README
index dae812a8d05791c380b5fda08d1d2aebd11236b3..eda9a5507cb83ca338490ffc9865b3df3e2ebfa3 100644 (file)
--- a/README
+++ b/README
@@ -149,8 +149,18 @@ the PYTHON_CPPFLAGS and PYTHON_LIBS variables in order to point the build
 system to the correct locations. During native builds, the configure script
 can auto-detect the location of the development files.
 
-Both bindings are extensively documented: with doxygen markup in case of C++
-and inline pydoc comments for python.
+DOCUMENTATION
+-------------
+
+All API symbols exposed by the core C API and C++ bindings are documented with
+doxygen markup blocks. Doxygen documentation can be generated by executing
+'make doc' given that the doxygen executable is available in the system.
+
+Python bindings contain help strings that can be accessed with the help
+builtin.
+
+Man pages for command-line programs are generated automatically if gpio-tools
+were selected and help2man is available in the system.
 
 CONTRIBUTING
 ------------