Re: [cc65] Platform specific docs

Date view Thread view Subject view

From: Adam Dunkels (adam_at_sics.se)
Date: 2003-09-23 23:12:08


On Tue, 2003-09-23 at 23:00, MagerValp wrote:
> >>>>> "UvB" == Ullrich von Bassewitz <uz_at_musoftware.de> writes:
> 
> UvB> The function reference is incomplete. I've asked for help here in
> UvB> the list, but I'm still the only one working on it, so it will
> UvB> take some time. Writing detailed information for all standard C
> UvB> functions plus all platform dependent functions is a *real* lot
> UvB> of work.
> 
> Ah. What about those "automated" function reference systems like the
> one Contiki just started using?

Even with a nice documentation system like Doxygen (which is the system
that Contiki just started using) all the hard work with actually writing
the documentation still has to be done and that is made no easier
because of the documentation system ;-)

Still, it makes it easier to keep the documentation in synch with the
code because it is easy to change the documentation when it is more or
less interleaved with the code.

I personally started liking Doxygen after having worked with it for some
time, but I guess it is a lot about personal taste and what one is used
to.

Cheers,

/adam
-- 
Adam Dunkels <adam_at_sics.se>
http://www.sics.se/~adam/

----------------------------------------------------------------------
To unsubscribe from the list send mail to majordomo_at_musoftware.de with
the string "unsubscribe cc65" in the body(!) of the mail.


Date view Thread view Subject view

This archive was generated by hypermail 2.1.3 : 2003-09-23 23:14:05 CEST