Csound Csound-dev Csound-tekno Search About

Re: [Cs-dev] Csound 5 Reference Manual

Date2005-11-15 19:30
FromMichael Gogins
SubjectRe: [Cs-dev] Csound 5 Reference Manual
Best to keep it in the csound 5 directory, as that means one less thing to be documented and maintained.

Regards,
Mike

-----Original Message-----
From: Istvan Varga 
Sent: Nov 15, 2005 2:09 PM
To: csound-devel@lists.sourceforge.net
Subject: Re: [Cs-dev] Csound 5 Reference Manual

Steven Yi wrote:

> also find that most Java libraries publish API docs using Javadoc, but
> also put out manuals that are more illustrative of how to use the API.
>  So I see no problems with having both.

That is what I meant, having short but usable descriptions in
header files, and a separate more detailed manual. Obviously, the
latter should only be written when the API is reasonably stable
and finished, as it would otherwise easily get out of sync.

> would belong in the Users manual.  Otherwise, setting up a stubbed
> developer's manual shouldn't take too long to set up if someone would
> like me to do so.  Just a matter of where to put it(in csound5
> directory, create a new repository?).

I would prefer a new repository (or just a single manual with
both the user and development info, but that would probably be
too large, complex, and difficult to maintain), as the csound5
directory already has more than enough files.


-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.  Get Certified Today
Register for a JBoss Training Course.  Free Certification Exam
for All Training Attendees Through End of 2005. For more info visit:
http://ads.osdn.com/?ad_id=7628&alloc_id=16845&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/csound-devel





-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.  Get Certified Today
Register for a JBoss Training Course.  Free Certification Exam
for All Training Attendees Through End of 2005. For more info visit:
http://ads.osdn.com/?ad_id=7628&alloc_id=16845&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net