Difference between revisions of "API Reference"
From uGFX Wiki
(→What is doxygen?) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
The µGFX library is fully in-source code documented using [http://doxygen.org doxygen]. | The µGFX library is fully in-source code documented using [http://doxygen.org doxygen]. | ||
| + | The API reference of the uGFX library can be found [http://api.ugfx.io here]. | ||
== What is doxygen? == | == What is doxygen? == | ||
From [http://en.wikipedia.org/wiki/Doxygen Wikipedia], the free encyclopedia: | From [http://en.wikipedia.org/wiki/Doxygen Wikipedia], the free encyclopedia: | ||
<pre> | <pre> | ||
| − | 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 is a documentation generator, a tool for writing software reference documentation. |
| − | Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code. | + | 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. | ||
</pre> | </pre> | ||
| − | + | [[Category:General]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Latest revision as of 07:56, 17 March 2018
The µGFX library is fully in-source code documented using doxygen.
The API reference of the uGFX library can be found here.
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.
