[jallib] Re: documenation generation

Wed, 25 Mar 2009 02:41:00 -0700 

Hi Joep,

Doc generation does not consider conditional compiled procedures. It just
consider procedure/function/... at the beginning of lines (no indentation).
Maybe I could modify this so it also search procedure/function which are
indented. var/consts can't considered in this case, or the doc will display
*all* "internal" var/const. So I guess this is not the ideal case too, if
you want your "special constant under conditional compilation" to be
considered in doc. FYI, attached is your lcd_backlight.jal doc, generated
with current script.

One more thought: I understand you want users to be able to specify on which
PWM channel the LCD backlight will be controlled. Maybe some of this logic:


if channel == 1 then
    include pwm_ccp1
    -- use pwm1_*() procedures
end if


could be imported back to pwm libs: instead of accessing pwm procedures with
prefixed pwm1_*(), pwm2_*(), etc..., use a wrapper procedure taking the
channel number as argument, then dispatching to appropriate one. Then you
would ahev only one procedure definition:


procedure lcd_backlight_variable(byte in value) is
     ...
     pwm_set_dutycycle(lcd_backlight_pwm,value)
end procedure


I wonder how optimized the code could be, if ti's worth it, but I can give a
try.


Cheers,
Seb



> Hi Seb,
>
> In backlight.jal, there are some conditional compiled procedures. In
> this case, actually 4 of them and only one will be selected. Does this
> work with documentation generation? And is the comment (seel line 47)
> used or should I put it somewere else?
>
> Joep
>
> >
>


-- 
Sébastien Lelong
http://www.sirloon.net
http://sirbot.org

--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
Title: lcd_backlight - jallib API doc

lcd_backlight
lcd_backlight.jal

Author Joep Suijs, Copyright (c) 2009, all rights reserved.
Adapted-by
Compiler >=2.4g

Description 

Provides standard interface to backlight of (directly connected) lcd.


Dependencies

No dependency found



Summary

Global variables/contants

Procedures

Functions


API details

Global variables/contants

Procedures

Functions


Related samples

No sample found

Reply via email to