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.
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.
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).
<<quote HBP>>
How to preview comments made before publishing?
<</quote>>
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).
<<quote hlipka>>
<<quote HBP>>
How to preview comments made before publishing?
<</quote>>
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).
<</quote>>
Thanks.
Next question is: Can I embed images to documentation?
<<code>>\image <format> <file> ‘‘caption’’<</code>>
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.
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.
Please login to post comments.