Hi Seb,
Sebastien Lelong wrote:
> Stef had the habit of adding an ready_to_copy example include. From
> the orginal file is below.
> This seems to be lost in the jallib-isation.
>
>
> Yes, this is by intention, I *wanted* it to be removed from the lib. And
> put it in a sample ! Remember: what is in comments will never get
> compiled (dead code), samples will (living code). Now, this arises the
> problem of documenting things that aren't in the library: every
> constants, variables, pin aliases, etc... that must be declared *before*
> including the lib. For me, that's what the samples are for.
With the added comments I think the adc_hardware lib can be published
(my vote is now: 1).
I do not agree with your view about the function of samples.
A *learning* sample shows on purpose one *simple* of probably many
possibilities of a library. It is meant to get a new user started. But
after a first tryout users always want to do more complex things than
the sample shows! But how?
Some doc (either separate or as comment in the library) should inform
the user about everything the library can do. It should explain the
functionality of each procedure, the meaning and possible/allowed values
of the various external constants and variables, and the limitations.
Providing the complete information ('reference manual') allows him to
*learn* all by himself how to explore the possibilities of the library
for his specific needs.
Anyway, that's the way I would like it.
Regards, Rob.
--
Rob Hamerling, Vianen, NL (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
-~----------~----~----~----~------~----~------~--~---
