On 28-11-12 07:24, Oliver Seitz wrote:
>Implementing the suggestions mentioned in comments against r3106.
Sorry for
the delay!
Wow! It may now apply to the "Best documented library award" :-)
The text is OK, but the format not quite.
A description needs to be a contiguous piece of text. Empty lines, but
also empty comment lines (containing only "--") are treated as 'end of
description' when the documentation files are generated.
These lines need at least some non-blank character, like a dot.
For example, the debounce library contains now:
-- Description: This library provides a simple switch debounce function.
--
-- Quite often, when monitoring the state of a mechanical switch, it is
The second line 'breaks' the description. It better be:
-- Description: This library provides a simple switch debounce function.
-- .
-- Quite often, when monitoring the state of a mechanical switch, it is
The same applies to the description of variables, procedures and
functions: must be a contiguous block of lines just preceding the
variable, etc.
Is trivial in the source but makes quite a difference in the generated
documentation file!
Regards, Rob.
--
R. Hamerling, Netherlands --- http://www.robh.nl
--
You received this message because you are subscribed to the Google Groups
"jallib" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/jallib?hl=en.
