Re: documentation or lack thereof

[Takashi Iwai <tiwai@suse.de>]

At Mon, 09 Dec 2002 09:54:10 -0500,
John S. Denker <jsd@monmouth.com> wrote:
> 
> To look at the same glass from the half-full perspective,
> Takashi wrote:
> 
> > recently i wrote a small howto for writing an alsa-driver.  
> 
> That's good!
> 
> > please check the archive of alsa-devel ml.
> 
> It would be even better if the howto were integrated into
> the project package, not hiding in a list archive somewhere.

yes, of course, it will go into some cvs tree in near future.
it's just a draft version, and i'd like to put it in other formats.

> Maybe even comments in the code linking to the howto, so
> people can find it when they need it.

the comments in the driver code are also one of TODOs.
we need the comments at least for each exported function written in
kernel (java-)doc style.
i personlly think it would be better to copy & paste the text to the
corresponding part than to put a link to howto.


ciao,

Takashi


-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf