[Cs-dev] API docs
| Date | 2013-04-23 17:42 |
| From | Victor Lazzarini |
| Subject | [Cs-dev] API docs |
| Attachments | None None |
When responding to Jim Hearon today I realised that some of the module names in the API docs are misleading. In special http://csound.sourceforge.net/doc/html/group__FILEIO.html is not specifically to do witn FILE IO, but with setting IO parameters (input, midi input, output, etc), some of which can be file or not. Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie |
| Date | 2013-04-23 18:32 |
| From | Andres Cabrera |
| Subject | Re: [Cs-dev] API docs |
| Attachments | None None |
Changed. Any other suggestions? On Tue, Apr 23, 2013 at 9:42 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
|
| Date | 2013-04-23 18:42 |
| From | Victor Lazzarini |
| Subject | Re: [Cs-dev] API docs |
| Attachments | None None |
Thanks. not right now, but I've been improving bits of the comment text in csound.h. I am also wondering whether we should offer some new examples in addition to the minimal one in csound.h, showing the new compile and parameter setting functions. Victor On 23 Apr 2013, at 18:32, Andres Cabrera wrote:
Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie |
| Date | 2013-04-23 19:54 |
| From | Andres Cabrera |
| Subject | Re: [Cs-dev] API docs |
| Attachments | None None |
I think that's definitely a good idea. Whether it should go in the csound header or the wiki or the manual, I'm not sure... Cheers, Andrés
On Tue, Apr 23, 2013 at 10:42 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote:
|
| Date | 2013-04-23 20:38 |
| From | Michael Gogins |
| Subject | Re: [Cs-dev] API docs |
| Attachments | None None |
Anyone who uses the API will probably look at the header, and if it is in the header it will get into the API reference manual via doxygen. So it should go into the header. Regards,
Mike On Tue, Apr 23, 2013 at 2:54 PM, Andres Cabrera <mantaraya36@gmail.com> wrote:
Michael Gogins Irreducible Productions http://www.michael-gogins.com Michael dot Gogins at gmail dot com |
| Date | 2013-04-23 21:00 |
| From | Rory Walsh |
| Subject | Re: [Cs-dev] API docs |
| Attachments | None None |
I agree with Mike. I think the header is the best place for On 23 Apr 2013 20:39, "Michael Gogins" <michael.gogins@gmail.com> wrote:
|