RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Writing documentation improves the design of your code. Talking through your API and design decisions on paper allows you to think about them in a more formalized way. A nice side effect is that it allows people to contribute code that follows your original intentions as well.
RDK component code is documented following the Doxygen standards and guidelines. Doxygen is a popular open source tool for generating documentation from annotated C/C++ sources. Also Doxygen support documenting code written in other programming languages such as Python, PHP, Java etc.
The following tools are required to be installed in Linux machine (through apt-get install) to generate documentation with respect to various data flow diagrams.
The following are the steps to generate documentation using Doxygen tool.
doxygen.css - style sheet file used for formatting html output
Doxyfile - Configuration file that is needed for generating doxygen output
RDK-Logo.png - RDK Logo
Check out all the RDK component source code (Source code must be Doxygen complaint) for which document needs to be generated, for example :
$ git clone "https://code.rdkcentral.com/r/rdk/components/generic/wifi" wifi
Edit Doxyfile and set all configurations as required, given below are examples
PROJECT_NAME /* Name of the project */
OUTPUT_DIRECTORY /* output folder path */
Edit doxygen.dox, if the index page needs to be customized, add module names that will be shown in output index page
Use the following command at the command prompt, to generate html report
$ doxygen Doxyfile
Refer to Doxygen Guideline for uniform style of adding Doxygen comments for the RDK system.