This thread has been locked.

If you have a related question, please click the "Ask a related question" button in the top right corner. The newly created question will be automatically linked to this question.

Using doxygen to build html documentation from a doxygen file

Guru* 84110 points

A Community Member was looking at some TI documentation on the C6457, and he had successfully extracted the documentation from a doxygen file that was included in the TI released files. It was not as easy for me to figure out how to do that as it was for him, so I figured I would list out the steps here in hopes that someone else may be helped when they try to do that in the future.

For anyone's benefit on how to use doxygen:

  1. Download doxygen from www.doxygen.org/ which for me was redirected to http://www.stack.nl/~dimitri/doxygen/ . There is a blue box on the right side that says Download, to get to the download part of the page. I chose the self-installing 32-bit binary for WinXP, and told it to Run. Took all defaults.
  2. Make sure the CSL source is available somewhere. In this case I found it in the pdk's components folder, unzipped it and moved it to the same c6457 folder where the csl_c6457 folder is.
  3. Start Doxywizard and use File->Open to open the Doxyfile in the doc folder.
  4. In my case, the Source code directory and Destination directory had environment variables that Doxywizard does not recognize. So I used the Select buttons to find the folders for both. Source ended up as ../../csl_c6457_src since that is where I unzipped it to, and Destination was just "." (no quotes).
  5. All the rest of the defaults were fine, but it is always good to go through the Next buttons to see the available options.
  6. Go to the Run tab and click the Run doxygen button.
  7. In Windows Explorer, go to the docs\html folder and open the Index.html file to view the documentation.

If there are any comments or improvements, please reply here.

Regards,
RandyP

  • RandyP,

    Thanks for the post.

    From what I can tell, the 6457 CSL is the only CSL that requires the end user to perform the doXygen extraction themselves. Your instructions should be added as a file in the docs directory of the CSL. The same instructions can be found on the Processor Wiki.

    Robert Coburn