Sebastien LELONG wrote:
> OK, we have a problem... Since device files now are JSG compliant, I can
> generate html doc for them. The problem is the HTML files weigh about 83MB.
> Far too much for our current repos size limit.
>
> Do we you want doc for device files ? There's no comment saying "This
> TRIS_port_bit_nibble_d3 register is for blahblah..." but there's a list of
> all available constants, pseudo-var, proc, etc... I think it's worth having
> them, even if it's overkilled for our repos. I'd need to ask for more space
> at the GC hosting team.
>
> Another consequence is the jalapi menu is unreadable because the list is
> tooooooo long. I need to put a javascript tree here...
>
> Let me know what you want about doc for device files !
This documentation generator is nice! But I think for the device files
it is a bit of overkill, and will generate a lot of duplicate info.
I think it will be better to have a 'device independent' user guide with
an explanation how to read device files. I could convert my current
userguide to html, add some text and maybe add some chapters for
specific modules (ADC, PWM, etc). If necessary I could add more comments
in the device files.
By all means the device files are not that complicated, and the average
user doesn't need to read the more complicated stuff like shadowing
procedures. Reading a datasheet is probably more difficult.
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
-~----------~----~----~----~------~----~------~--~---
