Generate Documentation from Sample Projects

From Embedded Systems Learning Academy
Jump to: navigation, search


SJOne sample projects contain capability to generate nice documentation that can be very valuable. You are encouraged to generate latest documentation but you can view the documentation online too: SJOne Documentation

Generate Documentation

In Eclipse, you can generate documentation by following the steps below:

Locate Doxyfile in your project. You can double click on it to configure which directories to generate the documentation for.
Locate Doxygen Button. Click on this button to start generating documentation and wait for the process to finish.

Browse Documentation

Locate _Docs/html/index.html. Right click on this file and open it up in System Editor
Once you open index.html, you will see a welcome page with some information.
You can search for "Board IO" (or search something else) and click on the link.
Now you can look up documentation of Board IO Classes.