Difference between revisions of "API Reference"
From uGFX Wiki
(→What is doxygen?) |
(→What is doxygen?) |
||
| Line 5: | Line 5: | ||
From Wikipedia, the free encyclopedia: | From Wikipedia, the free encyclopedia: | ||
<pre> | <pre> | ||
| − | Doxygen is a documentation generator, a tool for writing software reference documentation. | + | Doxygen is a documentation generator, a tool for writing software reference documentation. The documentation is written within code, and is thus relatively easy to keep up to date. |
| − | The documentation is written within code, and is thus relatively easy to keep up to date. | + | |
Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code. | Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code. | ||
</pre> | </pre> | ||
Revision as of 18:01, 1 July 2014
The µGFX library is fully in-source code documented using doxygen.
What is doxygen?
From Wikipedia, the free encyclopedia:
Doxygen is a documentation generator, a tool for writing software reference documentation. The documentation is written within code, and is thus relatively easy to keep up to date. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code.
Where can I find the doxygen documentation?
You can explore the doxygen of the latest release as well as of the latest repository state on this page. While we update the release documentation at any new release, the documentation of the current master is refreshed on a weekly base.
