From: Bartosz Golaszewski Date: Tue, 19 Feb 2019 16:34:39 +0000 (+0100) Subject: README: add a section about API documentation X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=acc337c9ef134b7b3100088958afd10e75c752af;p=qemu-gpiodev%2Flibgpiod.git 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 --- diff --git a/README b/README index dae812a..eda9a55 100644 --- 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 ------------