Hardware manual

'funcname()' - function

'$ENVVAR' - environmental variable

'&struct_name' - name of a structure (up to two words

including 'struct')

'@parameter' - name of a parameter

'%CONST' - name of a constant.

Finally when the description will be finished, we just type:

./kernel-doc -html somefile.c > output.html

In this way we can generate different kinds of documentation: html, docbook, text or man. The

documentation of bldctest.c and bldc.c are attached in Appendix A.

Additionally the documentation attached in Appendix B for HalDetector program was created

using Doxygen 1.5.2. The chose of this doc program was mostly due to the fact, that it can be

very easily integrated with KDevelop. Additionally it has several different output possibilities like

for example: html, latex, rtf, man, xml and others.

Because of variety possibilities for making documentation  different styles and many

commands, I decided not to write here examples like for kernel-doc. Nevertheless, for all who

are interested in details of Doxygen, there is a good manual free available on the homepage of

the project. The manual has a plenty of examples for each command with resulting outputs.