Documentation Team/API Documentation: Difference between revisions
m DocumentationTeam/API Documentation moved to Documentation Team/API Documentation: deCamel casing |
m fix broken links |
||
| Line 149: | Line 149: | ||
'''4. Write a main page for your application.''' | '''4. Write a main page for your application.''' | ||
This is usually done in a separate file | This is usually done in a separate file in the top-level of a library or application. The file's content is just a single apidox comment that starts with /** @mainpage title ; the rest of the file is just a long comment about what the library or application is for. | ||
== Fixing APIDOX in Old Code == | == Fixing APIDOX in Old Code == | ||
| Line 380: | Line 380: | ||
Very useful, in fact, for the reader who is wondering | Very useful, in fact, for the reader who is wondering | ||
how exactly to use the class in a straightforward way. | how exactly to use the class in a straightforward way. | ||
Most classes | Most classes have example code. | ||
One way to write example code is to use @code and @endcode around | One way to write example code is to use @code and @endcode around | ||
| Line 396: | Line 396: | ||
</code> | </code> | ||
This is how most of the examples | This is how most of the examples | ||
are done, actually. It works reasonably well, you can pare the | are done, actually. It works reasonably well, you can pare the | ||
example down to something really minimal and leave out all the | example down to something really minimal and leave out all the | ||