Documentation Homepage HAMLib reference Back to HAM Homepage

Introducing the new HAMdoc

I really liked the old HAMdoc format! Why did you change it?

Simple. The old documentation was a completely separate piece of information that had to be updated completely separate from the code changes. It was therefore very hard to keep the documentation 100% in sync with changes in HAM. As HAM is growing rapidly whereas my time is not, I had to change the way documentation is created and kept up to date. I looked around for free tools on this for a while, and finally selected Doxygen ( http://www.doxygen.org ).

What has changed?

Doxygen directly uses the HAMlib source code as the input to create the new documentation. This has several key advantages:

• all function names and parameter formats are always 100% correctly documented
• 100% function coverage in the docs. You will note several functions that you never heard of before, simply because I forgot to document them.
• update proof: When I change code in HAMlib, it is directly reflected in the documentation, even if there is no extra documentation set up, the new/changed functions will show up.

Isn't this just a reformatted version of what we already have?

Not really. First, read the above, that is a core difference. Second, there are many new documenation entries. Third, the FAQ has been completely rewritten amongst other sections. It was a lot of work to do intiially, but I am very happy with the result now. I hope you will be , too.

But I don't like the fonts :-(

Sorry about them. But I think the overall documentation is a lot better now.