Page History

...

1. Create a new folder “example_name" – This is where the final report will reside.
2. Go to directory “example_name”
3. Get the reference doxygen configuration file
   TODO : Add description regarding where to get the reference doxygen configuration file.
   
   1. doxygen.dox - used for customizing the index page

   2. doxygen.css - style sheet file used for formatting html output

   3. Doxyfile - Configuration file that is needed for generating doxygen output

   4. RDK-Logo.png - RDK Logo

4. 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

5. Edit Doxyfile and set all configurations as required, given below are examples

   • PROJECT_NAME  /* Name of the project */

   • INPUT   /* Path of source code provided as input for document generation*/

   • OUTPUT_DIRECTORY /* output folder path */

6. Edit doxygen.dox, if the index page needs to be customized, add module names that will be shown in output index page

7. Edit doxygen.css, for output formats, fonts, etc

8. Use the following command at the command prompt, to generate html report

   • $ doxygen Doxyfile

9. Doxygen Output HTML report will be available at  '/example_name/OUTPUT_DIRECTORY/html' folder, open index.html file to see Doxygen report

...