Table of Contents

Why to Document?

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.

...

Tools Required for Doxygen Documentation

...

Tools Required for Doxygen Documentation

Anchor
Tools Required for Doxygen Documentation Tools Required for Doxygen Documentation

...

Refer to Doxygen Guideline for uniform style of adding Doxygen comments for the RDK system.

...

For more info on Doxygen usage, refer  :  Doxygen Documentation Guide