Documenting a Library

This page has been superceded by API Documentation on the handbook.





5 comments:

06 Jan 2011

Another thing for the troubleshooting box that got me when I first started doing this stuff is that a @code without an @endcode will break your documentation.

21 Feb 2011

How to preview comments made before publishing?

21 Feb 2011

user Olli Vanhoja wrote:

How to preview comments made before publishing?

The only thing which comes to my mind is to publish the code, but not making it public (which can be de-selected in the publishing dialog).

22 Feb 2011

user Hendrik Lipka wrote:

user Olli Vanhoja wrote:

How to preview comments made before publishing?

The only thing which comes to my mind is to publish the code, but not making it public (which can be de-selected in the publishing dialog).

Thanks.

Next question is: Can I embed images to documentation?

<<code>>\image <format> <file> ‘‘caption’’<</code>>

08 Apr 2012

The mbed libs have a tree that when expanded show the docs in the editor, can we do this for our own libs? I have commented mine and added comments but the docs are only available from the doc page of the lib. Would be nice if I did not need to click the "See the documentation for this library (new window)" link when I click the lib.