[Cs-dev] API docs

[Cs-dev] API docs

Date	2013-04-18 05:28
From	Andres Cabrera
Subject	[Cs-dev] API docs
	Hi, I've added some more documentation for the API. I'd appreciate a look particularly to csdl.h, as I'm not sure I got it right. http://csound.sourceforge.net/doc/html/index.html Cheers, Andrés ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.s

Date	2013-04-18 11:03
From	Rory Walsh
Subject	Re: [Cs-dev] API docs
Attachments	None None
	This looks great Andres. I've never really used csdl.h so I can't say if it's correct or not, but all of these improvements are really great. On 18 April 2013 05:28, Andres Cabrera <mantaraya36@gmail.com> wrote: Hi, I've added some more documentation for the API. I'd appreciate a look particularly to csdl.h, as I'm not sure I got it right. http://csound.sourceforge.net/doc/html/index.html Cheers, Andrés ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel

Date	2013-04-18 15:12
From	Victor Lazzarini
Subject	Re: [Cs-dev] API docs
	Andres, csdl.h: the LINKAGE macro is sufficient, there is no need to call these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). Regards Victor On 18 Apr 2013, at 05:28, Andres Cabrera wrote: > Hi, > > I've added some more documentation for the API. I'd appreciate a look > particularly to csdl.h, as I'm not sure I got it right. > > http://csound.sourceforge.net/doc/html/index.html > > Cheers, > Andrés > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net

Date	2013-04-18 23:00
From	Andres Cabrera
Subject	Re: [Cs-dev] API docs
Attachments	None None
	Thanks for the info Victor. Will commit the change soon. So these functions are optional, which is good. I'm just curious, how is that handled technically, since the functions are in the header? Cheers, Andrés On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Andres, csdl.h: the LINKAGE macro is sufficient, there is no need to call these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). Regards Victor On 18 Apr 2013, at 05:28, Andres Cabrera wrote: > Hi, > > I've added some more documentation for the API. I'd appreciate a look > particularly to csdl.h, as I'm not sure I got it right. > > http://csound.sourceforge.net/doc/html/index.html > > Cheers, > Andrés > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel

Date	2013-04-18 23:26
From	Victor Lazzarini
Subject	Re: [Cs-dev] API docs
Attachments	None None
	Some plugins (like the IO ones) actually use them. See in Top/csmodule.c (csoundLoadExternal()) how they are called. On 18 Apr 2013, at 23:00, Andres Cabrera wrote: Thanks for the info Victor. Will commit the change soon. So these functions are optional, which is good. I'm just curious, how is that handled technically, since the functions are in the header? Cheers, Andrés On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Andres, csdl.h: the LINKAGE macro is sufficient, there is no need to call these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). Regards Victor On 18 Apr 2013, at 05:28, Andres Cabrera wrote: > Hi, > > I've added some more documentation for the API. I'd appreciate a look > particularly to csdl.h, as I'm not sure I got it right. > > http://csound.sourceforge.net/doc/html/index.html > > Cheers, > Andrés > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel 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-24 19:15
From	Rory Walsh
Subject	Re: [Cs-dev] API docs
Attachments	None None
	it seems that the text describing the API function csoundListChannels() is still based on Csound 5. It makes mention of the CsoundChannelListEntry structure which I believe is now no longer available? On 18 April 2013 23:26, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Some plugins (like the IO ones) actually use them. See in Top/csmodule.c (csoundLoadExternal()) how they are called. On 18 Apr 2013, at 23:00, Andres Cabrera wrote: Thanks for the info Victor. Will commit the change soon. So these functions are optional, which is good. I'm just curious, how is that handled technically, since the functions are in the header? Cheers, Andrés On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Andres, csdl.h: the LINKAGE macro is sufficient, there is no need to call these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). Regards Victor On 18 Apr 2013, at 05:28, Andres Cabrera wrote: > Hi, > > I've added some more documentation for the API. I'd appreciate a look > particularly to csdl.h, as I'm not sure I got it right. > > http://csound.sourceforge.net/doc/html/index.html > > Cheers, > Andrés > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel

Date	2013-04-25 00:17
From	Andres Cabrera
Subject	Re: [Cs-dev] API docs
Attachments	None None
	Thanks. Fixed. Will commit soon. On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh <rorywalsh@ear.ie> wrote: it seems that the text describing the API function csoundListChannels() is still based on Csound 5. It makes mention of the CsoundChannelListEntry structure which I believe is now no longer available? On 18 April 2013 23:26, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Some plugins (like the IO ones) actually use them. See in Top/csmodule.c (csoundLoadExternal()) how they are called. On 18 Apr 2013, at 23:00, Andres Cabrera wrote: Thanks for the info Victor. Will commit the change soon. So these functions are optional, which is good. I'm just curious, how is that handled technically, since the functions are in the header? Cheers, Andrés On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Andres, csdl.h: the LINKAGE macro is sufficient, there is no need to call these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). Regards Victor On 18 Apr 2013, at 05:28, Andres Cabrera wrote: > Hi, > > I've added some more documentation for the API. I'd appreciate a look > particularly to csdl.h, as I'm not sure I got it right. > > http://csound.sourceforge.net/doc/html/index.html > > Cheers, > Andrés > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel

Date	2013-04-26 18:30
From	Rory Walsh
Subject	Re: [Cs-dev] API docs
Attachments	None None
	It seems that there are more and more examples being written about new features, in various languages. Is it possible to include these in the API docs? Including them in csound.h, as discussed previously will really bloat that file. I don't know doxygen well enough, but is there a way that a new tab can be added to the API docs that would display files in the same way csound.h is currently displayed? We could then include some nice informed examples with the API docs. It would also be nice to have doxygen generated docs for Python and Java to, but one thing at a time. Any thoughts? Would this be possible with doxygen? I certainly don't mind contributing examples in C/C++. I just don't know if they should go into csound.h... On 25 April 2013 00:17, Andres Cabrera <mantaraya36@gmail.com> wrote: Thanks. Fixed. Will commit soon. On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh <rorywalsh@ear.ie> wrote: it seems that the text describing the API function csoundListChannels() is still based on Csound 5. It makes mention of the CsoundChannelListEntry structure which I believe is now no longer available? On 18 April 2013 23:26, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Some plugins (like the IO ones) actually use them. See in Top/csmodule.c (csoundLoadExternal()) how they are called. On 18 Apr 2013, at 23:00, Andres Cabrera wrote: Thanks for the info Victor. Will commit the change soon. So these functions are optional, which is good. I'm just curious, how is that handled technically, since the functions are in the header? Cheers, Andrés On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Andres, csdl.h: the LINKAGE macro is sufficient, there is no need to call these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). Regards Victor On 18 Apr 2013, at 05:28, Andres Cabrera wrote: > Hi, > > I've added some more documentation for the API. I'd appreciate a look > particularly to csdl.h, as I'm not sure I got it right. > > http://csound.sourceforge.net/doc/html/index.html > > Cheers, > Andrés > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel

Date	2013-04-26 18:57
From	Andres Cabrera
Subject	Re: [Cs-dev] API docs
Attachments	None None
	Sorry, I don't know if this is possible with doxygen. Does swig offer any documentation functionality? It would be nice if it could take the c doxygen and use it for the other language bindings it produces... Cheers, Andrés On Fri, Apr 26, 2013 at 10:30 AM, Rory Walsh <rorywalsh@ear.ie> wrote: It seems that there are more and more examples being written about new features, in various languages. Is it possible to include these in the API docs? Including them in csound.h, as discussed previously will really bloat that file. I don't know doxygen well enough, but is there a way that a new tab can be added to the API docs that would display files in the same way csound.h is currently displayed? We could then include some nice informed examples with the API docs. It would also be nice to have doxygen generated docs for Python and Java to, but one thing at a time. Any thoughts? Would this be possible with doxygen? I certainly don't mind contributing examples in C/C++. I just don't know if they should go into csound.h... On 25 April 2013 00:17, Andres Cabrera <mantaraya36@gmail.com> wrote: Thanks. Fixed. Will commit soon. On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh <rorywalsh@ear.ie> wrote: it seems that the text describing the API function csoundListChannels() is still based on Csound 5. It makes mention of the CsoundChannelListEntry structure which I believe is now no longer available? On 18 April 2013 23:26, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Some plugins (like the IO ones) actually use them. See in Top/csmodule.c (csoundLoadExternal()) how they are called. On 18 Apr 2013, at 23:00, Andres Cabrera wrote: Thanks for the info Victor. Will commit the change soon. So these functions are optional, which is good. I'm just curious, how is that handled technically, since the functions are in the header? Cheers, Andrés On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini <Victor.Lazzarini@nuim.ie> wrote: Andres, csdl.h: the LINKAGE macro is sufficient, there is no need to call these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). Regards Victor On 18 Apr 2013, at 05:28, Andres Cabrera wrote: > Hi, > > I've added some more documentation for the API. I'd appreciate a look > particularly to csdl.h, as I'm not sure I got it right. > > http://csound.sourceforge.net/doc/html/index.html > > Cheers, > Andrés > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel Dr Victor Lazzarini Senior Lecturer Dept. of Music NUI Maynooth Ireland tel.: +353 1 708 3545 Victor dot Lazzarini AT nuim dot ie ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel

Date	2013-04-26 19:02
From	Rory Walsh
Subject	Re: [Cs-dev] API docs
	I just did a quick search and it seems that this might be possible. Can you let me know how to go about building the API docs myself so I can try a few things? I'm working on Linux here, so I guess it should be pretty easy to get set up? On 26/04/2013, Andres Cabrera wrote: > Sorry, I don't know if this is possible with doxygen. Does swig offer any > documentation functionality? It would be nice if it could take the c > doxygen and use it for the other language bindings it produces... > > Cheers, > Andrés > > > On Fri, Apr 26, 2013 at 10:30 AM, Rory Walsh wrote: > >> It seems that there are more and more examples being written about new >> features, in various languages. Is it possible to include these in the >> API >> docs? Including them in csound.h, as discussed previously will really >> bloat >> that file. I don't know doxygen well enough, but is there a way that a >> new >> tab can be added to the API docs that would display files in the same way >> csound.h is currently displayed? We could then include some nice informed >> examples with the API docs. It would also be nice to have doxygen >> generated >> docs for Python and Java to, but one thing at a time. Any thoughts? Would >> this be possible with doxygen? I certainly don't mind contributing >> examples >> in C/C++. I just don't know if they should go into csound.h... >> >> >> On 25 April 2013 00:17, Andres Cabrera wrote: >> >>> Thanks. Fixed. Will commit soon. >>> >>> >>> On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh wrote: >>> >>>> it seems that the text describing the API function csoundListChannels() >>>> is still based on Csound 5. It makes mention of the >>>> CsoundChannelListEntry >>>> structure which I believe is now no longer available? >>>> >>>> >>>> On 18 April 2013 23:26, Victor Lazzarini >>>> wrote: >>>> >>>>> Some plugins (like the IO ones) actually use them. See in >>>>> Top/csmodule.c (csoundLoadExternal()) how they are called. >>>>> >>>>> On 18 Apr 2013, at 23:00, Andres Cabrera wrote: >>>>> >>>>> Thanks for the info Victor. Will commit the change soon. So these >>>>> functions are optional, which is good. I'm just curious, how is that >>>>> handled technically, since the functions are in the header? >>>>> >>>>> Cheers, >>>>> Andrés >>>>> >>>>> >>>>> On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini < >>>>> Victor.Lazzarini@nuim.ie> wrote: >>>>> >>>>>> Andres, >>>>>> >>>>>> csdl.h: the LINKAGE macro is sufficient, there is no need to call >>>>>> these csoundModuleCreate(), csoundModuleInit() and >>>>>> csoundModuleDestroy(). >>>>>> >>>>>> Regards >>>>>> >>>>>> Victor >>>>>> >>>>>> On 18 Apr 2013, at 05:28, Andres Cabrera wrote: >>>>>> >>>>>> > Hi, >>>>>> > >>>>>> > I've added some more documentation for the API. I'd appreciate a >>>>>> > look >>>>>> > particularly to csdl.h, as I'm not sure I got it right. >>>>>> > >>>>>> > http://csound.sourceforge.net/doc/html/index.html >>>>>> > >>>>>> > Cheers, >>>>>> > Andrés >>>>>> > >>>>>> > >>>>>> ------------------------------------------------------------------------------ >>>>>> > Precog is a next-generation analytics platform capable of advanced >>>>>> > analytics on semi-structured data. The platform includes APIs for >>>>>> building >>>>>> > apps and a phenomenal toolset for data science. Developers can use >>>>>> > our toolset for easy data analysis & visualization. Get a free >>>>>> account! >>>>>> > http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> > _______________________________________________ >>>>>> > Csound-devel mailing list >>>>>> > Csound-devel@lists.sourceforge.net >>>>>> > https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>>> >>>>>> Dr Victor Lazzarini >>>>>> Senior Lecturer >>>>>> Dept. of Music >>>>>> NUI Maynooth Ireland >>>>>> tel.: +353 1 708 3545 >>>>>> Victor dot Lazzarini AT nuim dot ie >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> ------------------------------------------------------------------------------ >>>>>> Precog is a next-generation analytics platform capable of advanced >>>>>> analytics on semi-structured data. The platform includes APIs for >>>>>> building >>>>>> apps and a phenomenal toolset for data science. Developers can use >>>>>> our toolset for easy data analysis & visualization. Get a free >>>>>> account! >>>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> _______________________________________________ >>>>>> Csound-devel mailing list >>>>>> Csound-devel@lists.sourceforge.net >>>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free >>>>> account! >>>>> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>>> Dr Victor Lazzarini >>>>> Senior Lecturer >>>>> Dept. of Music >>>>> NUI Maynooth Ireland >>>>> tel.: +353 1 708 3545 >>>>> Victor dot Lazzarini AT nuim dot ie >>>>> >>>>> >>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free >>>>> account! >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>> _______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>> >>>> >>>> ------------------------------------------------------------------------------ >>>> Try New Relic Now & We'll Send You this Cool Shirt >>>> New Relic is the only SaaS-based application performance monitoring >>>> service >>>> that delivers powerful full stack analytics. Optimize and monitor your >>>> browser, app, & servers with just a few lines of code. Try New Relic >>>> and get this awesome Nerd Life shirt! >>>> http://p.sf.net/sfu/newrelic_d2d_apr >>>> >>>> _______________________________________________ >>>> Csound-devel mailing list >>>> Csound-devel@lists.sourceforge.net >>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>> >>>> >>> >>> >>> ------------------------------------------------------------------------------ >>> Try New Relic Now & We'll Send You this Cool Shirt >>> New Relic is the only SaaS-based application performance monitoring >>> service >>> that delivers powerful full stack analytics. Optimize and monitor your >>> browser, app, & servers with just a few lines of code. Try New Relic >>> and get this awesome Nerd Life shirt! >>> http://p.sf.net/sfu/newrelic_d2d_apr >>> _______________________________________________ >>> Csound-devel mailing list >>> Csound-devel@lists.sourceforge.net >>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>> >>> >> >> >> ------------------------------------------------------------------------------ >> Try New Relic Now & We'll Send You this Cool Shirt >> New Relic is the only SaaS-based application performance monitoring >> service >> that delivers powerful full stack analytics. Optimize and monitor your >> browser, app, & servers with just a few lines of code. Try New Relic >> and get this awesome Nerd Life shirt! >> http://p.sf.net/sfu/newrelic_d2d_apr >> _______________________________________________ >> Csound-devel mailing list >> Csound-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >> > ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net

Date	2013-04-26 19:11
From	Andres Cabrera
Subject	Re: [Cs-dev] API docs
Attachments	None None
	Hi, You just need doxygen. I usually use a program called doxywizard which is a graphical frontend to doxygen. I'm not sure where you can get them, I got them from my distro's repos. I'm still running an ancient version of Ubuntu, if you generate the docs with a more recent doxygen, the output will actually be better and you will even have a search box. Cheers, Andrés On Fri, Apr 26, 2013 at 11:02 AM, Rory Walsh <rorywalsh@ear.ie> wrote: I just did a quick search and it seems that this might be possible. Can you let me know how to go about building the API docs myself so I can try a few things? I'm working on Linux here, so I guess it should be pretty easy to get set up? On 26/04/2013, Andres Cabrera <mantaraya36@gmail.com> wrote: > Sorry, I don't know if this is possible with doxygen. Does swig offer any > documentation functionality? It would be nice if it could take the c > doxygen and use it for the other language bindings it produces... > > Cheers, > Andrés > > > On Fri, Apr 26, 2013 at 10:30 AM, Rory Walsh <rorywalsh@ear.ie> wrote: > >> It seems that there are more and more examples being written about new >> features, in various languages. Is it possible to include these in the >> API >> docs? Including them in csound.h, as discussed previously will really >> bloat >> that file. I don't know doxygen well enough, but is there a way that a >> new >> tab can be added to the API docs that would display files in the same way >> csound.h is currently displayed? We could then include some nice informed >> examples with the API docs. It would also be nice to have doxygen >> generated >> docs for Python and Java to, but one thing at a time. Any thoughts? Would >> this be possible with doxygen? I certainly don't mind contributing >> examples >> in C/C++. I just don't know if they should go into csound.h... >> >> >> On 25 April 2013 00:17, Andres Cabrera <mantaraya36@gmail.com> wrote: >> >>> Thanks. Fixed. Will commit soon. >>> >>> >>> On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh <rorywalsh@ear.ie> wrote: >>> >>>> it seems that the text describing the API function csoundListChannels() >>>> is still based on Csound 5. It makes mention of the >>>> CsoundChannelListEntry >>>> structure which I believe is now no longer available? >>>> >>>> >>>> On 18 April 2013 23:26, Victor Lazzarini >>>> <Victor.Lazzarini@nuim.ie>wrote: >>>> >>>>> Some plugins (like the IO ones) actually use them. See in >>>>> Top/csmodule.c (csoundLoadExternal()) how they are called. >>>>> >>>>> On 18 Apr 2013, at 23:00, Andres Cabrera wrote: >>>>> >>>>> Thanks for the info Victor. Will commit the change soon. So these >>>>> functions are optional, which is good. I'm just curious, how is that >>>>> handled technically, since the functions are in the header? >>>>> >>>>> Cheers, >>>>> Andrés >>>>> >>>>> >>>>> On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini < >>>>> Victor.Lazzarini@nuim.ie> wrote: >>>>> >>>>>> Andres, >>>>>> >>>>>> csdl.h: the LINKAGE macro is sufficient, there is no need to call >>>>>> these csoundModuleCreate(), csoundModuleInit() and >>>>>> csoundModuleDestroy(). >>>>>> >>>>>> Regards >>>>>> >>>>>> Victor >>>>>> >>>>>> On 18 Apr 2013, at 05:28, Andres Cabrera wrote: >>>>>> >>>>>> > Hi, >>>>>> > >>>>>> > I've added some more documentation for the API. I'd appreciate a >>>>>> > look >>>>>> > particularly to csdl.h, as I'm not sure I got it right. >>>>>> > >>>>>> > http://csound.sourceforge.net/doc/html/index.html >>>>>> > >>>>>> > Cheers, >>>>>> > Andrés >>>>>> > >>>>>> > >>>>>> ------------------------------------------------------------------------------ >>>>>> > Precog is a next-generation analytics platform capable of advanced >>>>>> > analytics on semi-structured data. The platform includes APIs for >>>>>> building >>>>>> > apps and a phenomenal toolset for data science. Developers can use >>>>>> > our toolset for easy data analysis & visualization. Get a free >>>>>> account! >>>>>> > http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> > _______________________________________________ >>>>>> > Csound-devel mailing list >>>>>> > Csound-devel@lists.sourceforge.net >>>>>> > https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>>> >>>>>> Dr Victor Lazzarini >>>>>> Senior Lecturer >>>>>> Dept. of Music >>>>>> NUI Maynooth Ireland >>>>>> tel.: +353 1 708 3545 >>>>>> Victor dot Lazzarini AT nuim dot ie >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> ------------------------------------------------------------------------------ >>>>>> Precog is a next-generation analytics platform capable of advanced >>>>>> analytics on semi-structured data. The platform includes APIs for >>>>>> building >>>>>> apps and a phenomenal toolset for data science. Developers can use >>>>>> our toolset for easy data analysis & visualization. Get a free >>>>>> account! >>>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> _______________________________________________ >>>>>> Csound-devel mailing list >>>>>> Csound-devel@lists.sourceforge.net >>>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free >>>>> account! >>>>> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>>> Dr Victor Lazzarini >>>>> Senior Lecturer >>>>> Dept. of Music >>>>> NUI Maynooth Ireland >>>>> tel.: +353 1 708 3545 >>>>> Victor dot Lazzarini AT nuim dot ie >>>>> >>>>> >>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free >>>>> account! >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>> _______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>> >>>> >>>> ------------------------------------------------------------------------------ >>>> Try New Relic Now & We'll Send You this Cool Shirt >>>> New Relic is the only SaaS-based application performance monitoring >>>> service >>>> that delivers powerful full stack analytics. Optimize and monitor your >>>> browser, app, & servers with just a few lines of code. Try New Relic >>>> and get this awesome Nerd Life shirt! >>>> http://p.sf.net/sfu/newrelic_d2d_apr >>>> >>>> _______________________________________________ >>>> Csound-devel mailing list >>>> Csound-devel@lists.sourceforge.net >>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>> >>>> >>> >>> >>> ------------------------------------------------------------------------------ >>> Try New Relic Now & We'll Send You this Cool Shirt >>> New Relic is the only SaaS-based application performance monitoring >>> service >>> that delivers powerful full stack analytics. Optimize and monitor your >>> browser, app, & servers with just a few lines of code. Try New Relic >>> and get this awesome Nerd Life shirt! >>> http://p.sf.net/sfu/newrelic_d2d_apr >>> _______________________________________________ >>> Csound-devel mailing list >>> Csound-devel@lists.sourceforge.net >>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>> >>> >> >> >> ------------------------------------------------------------------------------ >> Try New Relic Now & We'll Send You this Cool Shirt >> New Relic is the only SaaS-based application performance monitoring >> service >> that delivers powerful full stack analytics. Optimize and monitor your >> browser, app, & servers with just a few lines of code. Try New Relic >> and get this awesome Nerd Life shirt! >> http://p.sf.net/sfu/newrelic_d2d_apr >> _______________________________________________ >> Csound-devel mailing list >> Csound-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >> > ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel

Date	2013-04-26 19:14
From	Steven Yi
Subject	Re: [Cs-dev] API docs
	+1 to finding a way to get doxygen docs generated into the SWIG bindings. It'd be extremely helpful when using python to just do "dir(csnd6.Csound)" and help(csnd6.Csound.someMethod). On Fri, Apr 26, 2013 at 6:57 PM, Andres Cabrera wrote: > Sorry, I don't know if this is possible with doxygen. Does swig offer any > documentation functionality? It would be nice if it could take the c doxygen > and use it for the other language bindings it produces... > > Cheers, > Andrés > > > On Fri, Apr 26, 2013 at 10:30 AM, Rory Walsh wrote: >> >> It seems that there are more and more examples being written about new >> features, in various languages. Is it possible to include these in the API >> docs? Including them in csound.h, as discussed previously will really bloat >> that file. I don't know doxygen well enough, but is there a way that a new >> tab can be added to the API docs that would display files in the same way >> csound.h is currently displayed? We could then include some nice informed >> examples with the API docs. It would also be nice to have doxygen generated >> docs for Python and Java to, but one thing at a time. Any thoughts? Would >> this be possible with doxygen? I certainly don't mind contributing examples >> in C/C++. I just don't know if they should go into csound.h... >> >> >> On 25 April 2013 00:17, Andres Cabrera wrote: >>> >>> Thanks. Fixed. Will commit soon. >>> >>> >>> On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh wrote: >>>> >>>> it seems that the text describing the API function csoundListChannels() >>>> is still based on Csound 5. It makes mention of the CsoundChannelListEntry >>>> structure which I believe is now no longer available? >>>> >>>> >>>> On 18 April 2013 23:26, Victor Lazzarini >>>> wrote: >>>>> >>>>> Some plugins (like the IO ones) actually use them. See in >>>>> Top/csmodule.c (csoundLoadExternal()) how they are called. >>>>> >>>>> On 18 Apr 2013, at 23:00, Andres Cabrera wrote: >>>>> >>>>> Thanks for the info Victor. Will commit the change soon. So these >>>>> functions are optional, which is good. I'm just curious, how is that handled >>>>> technically, since the functions are in the header? >>>>> >>>>> Cheers, >>>>> Andrés >>>>> >>>>> >>>>> On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini >>>>> wrote: >>>>>> >>>>>> Andres, >>>>>> >>>>>> csdl.h: the LINKAGE macro is sufficient, there is no need to call >>>>>> these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). >>>>>> >>>>>> Regards >>>>>> >>>>>> Victor >>>>>> >>>>>> On 18 Apr 2013, at 05:28, Andres Cabrera wrote: >>>>>> >>>>>> > Hi, >>>>>> > >>>>>> > I've added some more documentation for the API. I'd appreciate a >>>>>> > look >>>>>> > particularly to csdl.h, as I'm not sure I got it right. >>>>>> > >>>>>> > http://csound.sourceforge.net/doc/html/index.html >>>>>> > >>>>>> > Cheers, >>>>>> > Andrés >>>>>> > >>>>>> > >>>>>> > ------------------------------------------------------------------------------ >>>>>> > Precog is a next-generation analytics platform capable of advanced >>>>>> > analytics on semi-structured data. The platform includes APIs for >>>>>> > building >>>>>> > apps and a phenomenal toolset for data science. Developers can use >>>>>> > our toolset for easy data analysis & visualization. Get a free >>>>>> > account! >>>>>> > http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> > _______________________________________________ >>>>>> > Csound-devel mailing list >>>>>> > Csound-devel@lists.sourceforge.net >>>>>> > https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>>> >>>>>> Dr Victor Lazzarini >>>>>> Senior Lecturer >>>>>> Dept. of Music >>>>>> NUI Maynooth Ireland >>>>>> tel.: +353 1 708 3545 >>>>>> Victor dot Lazzarini AT nuim dot ie >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> ------------------------------------------------------------------------------ >>>>>> Precog is a next-generation analytics platform capable of advanced >>>>>> analytics on semi-structured data. The platform includes APIs for >>>>>> building >>>>>> apps and a phenomenal toolset for data science. Developers can use >>>>>> our toolset for easy data analysis & visualization. Get a free >>>>>> account! >>>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> _______________________________________________ >>>>>> Csound-devel mailing list >>>>>> Csound-devel@lists.sourceforge.net >>>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free account! >>>>> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>>> Dr Victor Lazzarini >>>>> Senior Lecturer >>>>> Dept. of Music >>>>> NUI Maynooth Ireland >>>>> tel.: +353 1 708 3545 >>>>> Victor dot Lazzarini AT nuim dot ie >>>>> >>>>> >>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free account! >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>> _______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>> >>>> >>>> >>>> ------------------------------------------------------------------------------ >>>> Try New Relic Now & We'll Send You this Cool Shirt >>>> New Relic is the only SaaS-based application performance monitoring >>>> service >>>> that delivers powerful full stack analytics. Optimize and monitor your >>>> browser, app, & servers with just a few lines of code. Try New Relic >>>> and get this awesome Nerd Life shirt! >>>> http://p.sf.net/sfu/newrelic_d2d_apr >>>> >>>> _______________________________________________ >>>> Csound-devel mailing list >>>> Csound-devel@lists.sourceforge.net >>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>> >>> >>> >>> >>> ------------------------------------------------------------------------------ >>> Try New Relic Now & We'll Send You this Cool Shirt >>> New Relic is the only SaaS-based application performance monitoring >>> service >>> that delivers powerful full stack analytics. Optimize and monitor your >>> browser, app, & servers with just a few lines of code. Try New Relic >>> and get this awesome Nerd Life shirt! >>> http://p.sf.net/sfu/newrelic_d2d_apr >>> _______________________________________________ >>> Csound-devel mailing list >>> Csound-devel@lists.sourceforge.net >>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>> >> >> >> >> ------------------------------------------------------------------------------ >> Try New Relic Now & We'll Send You this Cool Shirt >> New Relic is the only SaaS-based application performance monitoring >> service >> that delivers powerful full stack analytics. Optimize and monitor your >> browser, app, & servers with just a few lines of code. Try New Relic >> and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr >> _______________________________________________ >> Csound-devel mailing list >> Csound-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/csound-devel >> > > > ------------------------------------------------------------------------------ > Try New Relic Now & We'll Send You this Cool Shirt > New Relic is the only SaaS-based application performance monitoring service > that delivers powerful full stack analytics. Optimize and monitor your > browser, app, & servers with just a few lines of code. Try New Relic > and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel > ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net

Date	2013-04-26 19:26
From	Jacob Joaquin
Subject	Re: [Cs-dev] API docs
Attachments	None None
	Here's an IPython tip that's really helping me get around csnd6 right now. It comes with insanely awesome autocomplete features. So if I have this: In [8]: import csnd6 In [9]: c = csnd6 And I do a <tab> after c.MyfltVector, it brings up this: In [10]: c.MyfltVector. c.MyfltVector.append c.MyfltVector.capacity c.MyfltVector.erase c.MyfltVector.iterator c.MyfltVector.push_back c.MyfltVector.resize c.MyfltVector.assign c.MyfltVector.clear c.MyfltVector.front c.MyfltVector.mro c.MyfltVector.rbegin c.MyfltVector.size c.MyfltVector.back c.MyfltVector.empty c.MyfltVector.get_allocator c.MyfltVector.pop c.MyfltVector.rend c.MyfltVector.swap c.MyfltVector.begin c.MyfltVector.end c.MyfltVector.insert c.MyfltVector.pop_back c.MyfltVector.reserve I can also bring up the code for the MyfltVector class with: c.MyfltVector?? With docstrings were generated, it'd even be a bigger help. On Fri, Apr 26, 2013 at 11:14 AM, Steven Yi <stevenyi@gmail.com> wrote: +1 to finding a way to get doxygen docs generated into the SWIG bindings. It'd be extremely helpful when using python to just do "dir(csnd6.Csound)" and help(csnd6.Csound.someMethod). On Fri, Apr 26, 2013 at 6:57 PM, Andres Cabrera <mantaraya36@gmail.com> wrote: > Sorry, I don't know if this is possible with doxygen. Does swig offer any > documentation functionality? It would be nice if it could take the c doxygen > and use it for the other language bindings it produces... > > Cheers, > Andrés > > > On Fri, Apr 26, 2013 at 10:30 AM, Rory Walsh <rorywalsh@ear.ie> wrote: >> >> It seems that there are more and more examples being written about new >> features, in various languages. Is it possible to include these in the API >> docs? Including them in csound.h, as discussed previously will really bloat >> that file. I don't know doxygen well enough, but is there a way that a new >> tab can be added to the API docs that would display files in the same way >> csound.h is currently displayed? We could then include some nice informed >> examples with the API docs. It would also be nice to have doxygen generated >> docs for Python and Java to, but one thing at a time. Any thoughts? Would >> this be possible with doxygen? I certainly don't mind contributing examples >> in C/C++. I just don't know if they should go into csound.h... >> >> >> On 25 April 2013 00:17, Andres Cabrera <mantaraya36@gmail.com> wrote: >>> >>> Thanks. Fixed. Will commit soon. >>> >>> >>> On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh <rorywalsh@ear.ie> wrote: >>>> >>>> it seems that the text describing the API function csoundListChannels() >>>> is still based on Csound 5. It makes mention of the CsoundChannelListEntry >>>> structure which I believe is now no longer available? >>>> >>>> >>>> On 18 April 2013 23:26, Victor Lazzarini <Victor.Lazzarini@nuim.ie> >>>> wrote: >>>>> >>>>> Some plugins (like the IO ones) actually use them. See in >>>>> Top/csmodule.c (csoundLoadExternal()) how they are called. >>>>> >>>>> On 18 Apr 2013, at 23:00, Andres Cabrera wrote: >>>>> >>>>> Thanks for the info Victor. Will commit the change soon. So these >>>>> functions are optional, which is good. I'm just curious, how is that handled >>>>> technically, since the functions are in the header? >>>>> >>>>> Cheers, >>>>> Andrés >>>>> >>>>> >>>>> On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini >>>>> <Victor.Lazzarini@nuim.ie> wrote: >>>>>> >>>>>> Andres, >>>>>> >>>>>> csdl.h: the LINKAGE macro is sufficient, there is no need to call >>>>>> these csoundModuleCreate(), csoundModuleInit() and csoundModuleDestroy(). >>>>>> >>>>>> Regards >>>>>> >>>>>> Victor >>>>>> >>>>>> On 18 Apr 2013, at 05:28, Andres Cabrera wrote: >>>>>> >>>>>> > Hi, >>>>>> > >>>>>> > I've added some more documentation for the API. I'd appreciate a >>>>>> > look >>>>>> > particularly to csdl.h, as I'm not sure I got it right. >>>>>> > >>>>>> > http://csound.sourceforge.net/doc/html/index.html >>>>>> > >>>>>> > Cheers, >>>>>> > Andrés >>>>>> > >>>>>> > >>>>>> > ------------------------------------------------------------------------------ >>>>>> > Precog is a next-generation analytics platform capable of advanced >>>>>> > analytics on semi-structured data. The platform includes APIs for >>>>>> > building >>>>>> > apps and a phenomenal toolset for data science. Developers can use >>>>>> > our toolset for easy data analysis & visualization. Get a free >>>>>> > account! >>>>>> > http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> > _______________________________________________ >>>>>> > Csound-devel mailing list >>>>>> > Csound-devel@lists.sourceforge.net >>>>>> > https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>>> >>>>>> Dr Victor Lazzarini >>>>>> Senior Lecturer >>>>>> Dept. of Music >>>>>> NUI Maynooth Ireland >>>>>> tel.: +353 1 708 3545 >>>>>> Victor dot Lazzarini AT nuim dot ie >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> ------------------------------------------------------------------------------ >>>>>> Precog is a next-generation analytics platform capable of advanced >>>>>> analytics on semi-structured data. The platform includes APIs for >>>>>> building >>>>>> apps and a phenomenal toolset for data science. Developers can use >>>>>> our toolset for easy data analysis & visualization. Get a free >>>>>> account! >>>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>>> _______________________________________________ >>>>>> Csound-devel mailing list >>>>>> Csound-devel@lists.sourceforge.net >>>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free account! >>>>> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>>> >>>>> Dr Victor Lazzarini >>>>> Senior Lecturer >>>>> Dept. of Music >>>>> NUI Maynooth Ireland >>>>> tel.: +353 1 708 3545 >>>>> Victor dot Lazzarini AT nuim dot ie >>>>> >>>>> >>>>> >>>>> >>>>> >>>>> ------------------------------------------------------------------------------ >>>>> Precog is a next-generation analytics platform capable of advanced >>>>> analytics on semi-structured data. The platform includes APIs for >>>>> building >>>>> apps and a phenomenal toolset for data science. Developers can use >>>>> our toolset for easy data analysis & visualization. Get a free account! >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >>>>> _______________________________________________ >>>>> Csound-devel mailing list >>>>> Csound-devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>>> >>>> >>>> >>>> >>>> ------------------------------------------------------------------------------ >>>> Try New Relic Now & We'll Send You this Cool Shirt >>>> New Relic is the only SaaS-based application performance monitoring >>>> service >>>> that delivers powerful full stack analytics. Optimize and monitor your >>>> browser, app, & servers with just a few lines of code. Try New Relic >>>> and get this awesome Nerd Life shirt! >>>> http://p.sf.net/sfu/newrelic_d2d_apr >>>> >>>> _______________________________________________ >>>> Csound-devel mailing list >>>> Csound-devel@lists.sourceforge.net >>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>>> >>> >>> >>> >>> ------------------------------------------------------------------------------ >>> Try New Relic Now & We'll Send You this Cool Shirt >>> New Relic is the only SaaS-based application performance monitoring >>> service >>> that delivers powerful full stack analytics. Optimize and monitor your >>> browser, app, & servers with just a few lines of code. Try New Relic >>> and get this awesome Nerd Life shirt! >>> http://p.sf.net/sfu/newrelic_d2d_apr >>> _______________________________________________ >>> Csound-devel mailing list >>> Csound-devel@lists.sourceforge.net >>> https://lists.sourceforge.net/lists/listinfo/csound-devel >>> >> >> >> >> ------------------------------------------------------------------------------ >> Try New Relic Now & We'll Send You this Cool Shirt >> New Relic is the only SaaS-based application performance monitoring >> service >> that delivers powerful full stack analytics. Optimize and monitor your >> browser, app, & servers with just a few lines of code. Try New Relic >> and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr >> _______________________________________________ >> Csound-devel mailing list >> Csound-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/csound-devel >> > > > ------------------------------------------------------------------------------ > Try New Relic Now & We'll Send You this Cool Shirt > New Relic is the only SaaS-based application performance monitoring service > that delivers powerful full stack analytics. Optimize and monitor your > browser, app, & servers with just a few lines of code. Try New Relic > and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel > ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel -- codehop.com \| #code #art #music

Date	2013-04-26 20:34
From	Steven Yi
Subject	Re: [Cs-dev] API docs
	I found that there is a doxy2swig.py script: http://wrapitk.googlecode.com/svn-history/r539/trunk/Languages/Doc/doxy2swig.py that seems to popup on google. I tried modifying Doxyfile to generate xml, then running this script, then adding an %include to the python_interface.i in interfaces folder. It worked, but the results were not what I would have wanted. The issue is that the documentation is done mostly on the C functions, not on the include/csound.hpp file. It's that class in csound.hpp that is used to generate the Csound class used in Python/Java/etc. I think if we wanted to to use the above, we'd have to document the methods in include/csound.hpp. On Fri, Apr 26, 2013 at 7:26 PM, Jacob Joaquin wrote: > Here's an IPython tip that's really helping me get around csnd6 right now. > It comes with insanely awesome autocomplete features. So if I have this: > > In [8]: import csnd6 > > In [9]: c = csnd6 > > And I do a after c.MyfltVector, it brings up this: > > In [10]: c.MyfltVector. > c.MyfltVector.append c.MyfltVector.capacity > c.MyfltVector.erase c.MyfltVector.iterator > c.MyfltVector.push_back c.MyfltVector.resize > c.MyfltVector.assign c.MyfltVector.clear > c.MyfltVector.front c.MyfltVector.mro > c.MyfltVector.rbegin c.MyfltVector.size > c.MyfltVector.back c.MyfltVector.empty > c.MyfltVector.get_allocator c.MyfltVector.pop c.MyfltVector.rend > c.MyfltVector.swap > c.MyfltVector.begin c.MyfltVector.end > c.MyfltVector.insert c.MyfltVector.pop_back > c.MyfltVector.reserve > > I can also bring up the code for the MyfltVector class with: > > c.MyfltVector?? > > With docstrings were generated, it'd even be a bigger help. > > > On Fri, Apr 26, 2013 at 11:14 AM, Steven Yi wrote: >> >> +1 to finding a way to get doxygen docs generated into the SWIG >> bindings. It'd be extremely helpful when using python to just do >> "dir(csnd6.Csound)" and help(csnd6.Csound.someMethod). >> >> On Fri, Apr 26, 2013 at 6:57 PM, Andres Cabrera >> wrote: >> > Sorry, I don't know if this is possible with doxygen. Does swig offer >> > any >> > documentation functionality? It would be nice if it could take the c >> > doxygen >> > and use it for the other language bindings it produces... >> > >> > Cheers, >> > Andrés >> > >> > >> > On Fri, Apr 26, 2013 at 10:30 AM, Rory Walsh wrote: >> >> >> >> It seems that there are more and more examples being written about new >> >> features, in various languages. Is it possible to include these in the >> >> API >> >> docs? Including them in csound.h, as discussed previously will really >> >> bloat >> >> that file. I don't know doxygen well enough, but is there a way that a >> >> new >> >> tab can be added to the API docs that would display files in the same >> >> way >> >> csound.h is currently displayed? We could then include some nice >> >> informed >> >> examples with the API docs. It would also be nice to have doxygen >> >> generated >> >> docs for Python and Java to, but one thing at a time. Any thoughts? >> >> Would >> >> this be possible with doxygen? I certainly don't mind contributing >> >> examples >> >> in C/C++. I just don't know if they should go into csound.h... >> >> >> >> >> >> On 25 April 2013 00:17, Andres Cabrera wrote: >> >>> >> >>> Thanks. Fixed. Will commit soon. >> >>> >> >>> >> >>> On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh wrote: >> >>>> >> >>>> it seems that the text describing the API function >> >>>> csoundListChannels() >> >>>> is still based on Csound 5. It makes mention of the >> >>>> CsoundChannelListEntry >> >>>> structure which I believe is now no longer available? >> >>>> >> >>>> >> >>>> On 18 April 2013 23:26, Victor Lazzarini >> >>>> wrote: >> >>>>> >> >>>>> Some plugins (like the IO ones) actually use them. See in >> >>>>> Top/csmodule.c (csoundLoadExternal()) how they are called. >> >>>>> >> >>>>> On 18 Apr 2013, at 23:00, Andres Cabrera wrote: >> >>>>> >> >>>>> Thanks for the info Victor. Will commit the change soon. So these >> >>>>> functions are optional, which is good. I'm just curious, how is that >> >>>>> handled >> >>>>> technically, since the functions are in the header? >> >>>>> >> >>>>> Cheers, >> >>>>> Andrés >> >>>>> >> >>>>> >> >>>>> On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini >> >>>>> wrote: >> >>>>>> >> >>>>>> Andres, >> >>>>>> >> >>>>>> csdl.h: the LINKAGE macro is sufficient, there is no need to call >> >>>>>> these csoundModuleCreate(), csoundModuleInit() and >> >>>>>> csoundModuleDestroy(). >> >>>>>> >> >>>>>> Regards >> >>>>>> >> >>>>>> Victor >> >>>>>> >> >>>>>> On 18 Apr 2013, at 05:28, Andres Cabrera wrote: >> >>>>>> >> >>>>>> > Hi, >> >>>>>> > >> >>>>>> > I've added some more documentation for the API. I'd appreciate a >> >>>>>> > look >> >>>>>> > particularly to csdl.h, as I'm not sure I got it right. >> >>>>>> > >> >>>>>> > http://csound.sourceforge.net/doc/html/index.html >> >>>>>> > >> >>>>>> > Cheers, >> >>>>>> > Andrés >> >>>>>> > >> >>>>>> > >> >>>>>> > >> >>>>>> > ------------------------------------------------------------------------------ >> >>>>>> > Precog is a next-generation analytics platform capable of >> >>>>>> > advanced >> >>>>>> > analytics on semi-structured data. The platform includes APIs for >> >>>>>> > building >> >>>>>> > apps and a phenomenal toolset for data science. Developers can >> >>>>>> > use >> >>>>>> > our toolset for easy data analysis & visualization. Get a free >> >>>>>> > account! >> >>>>>> > http://www2.precog.com/precogplatform/slashdotnewsletter >> >>>>>> > _______________________________________________ >> >>>>>> > Csound-devel mailing list >> >>>>>> > Csound-devel@lists.sourceforge.net >> >>>>>> > https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>>> >> >>>>>> Dr Victor Lazzarini >> >>>>>> Senior Lecturer >> >>>>>> Dept. of Music >> >>>>>> NUI Maynooth Ireland >> >>>>>> tel.: +353 1 708 3545 >> >>>>>> Victor dot Lazzarini AT nuim dot ie >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> ------------------------------------------------------------------------------ >> >>>>>> Precog is a next-generation analytics platform capable of advanced >> >>>>>> analytics on semi-structured data. The platform includes APIs for >> >>>>>> building >> >>>>>> apps and a phenomenal toolset for data science. Developers can use >> >>>>>> our toolset for easy data analysis & visualization. Get a free >> >>>>>> account! >> >>>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >> >>>>>> _______________________________________________ >> >>>>>> Csound-devel mailing list >> >>>>>> Csound-devel@lists.sourceforge.net >> >>>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> ------------------------------------------------------------------------------ >> >>>>> Precog is a next-generation analytics platform capable of advanced >> >>>>> analytics on semi-structured data. The platform includes APIs for >> >>>>> building >> >>>>> apps and a phenomenal toolset for data science. Developers can use >> >>>>> our toolset for easy data analysis & visualization. Get a free >> >>>>> account! >> >>>>> >> >>>>> >> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ >> >>>>> Csound-devel mailing list >> >>>>> Csound-devel@lists.sourceforge.net >> >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>> >> >>>>> >> >>>>> Dr Victor Lazzarini >> >>>>> Senior Lecturer >> >>>>> Dept. of Music >> >>>>> NUI Maynooth Ireland >> >>>>> tel.: +353 1 708 3545 >> >>>>> Victor dot Lazzarini AT nuim dot ie >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> ------------------------------------------------------------------------------ >> >>>>> Precog is a next-generation analytics platform capable of advanced >> >>>>> analytics on semi-structured data. The platform includes APIs for >> >>>>> building >> >>>>> apps and a phenomenal toolset for data science. Developers can use >> >>>>> our toolset for easy data analysis & visualization. Get a free >> >>>>> account! >> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >> >>>>> _______________________________________________ >> >>>>> Csound-devel mailing list >> >>>>> Csound-devel@lists.sourceforge.net >> >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>> >> >>>> >> >>>> >> >>>> >> >>>> >> >>>> ------------------------------------------------------------------------------ >> >>>> Try New Relic Now & We'll Send You this Cool Shirt >> >>>> New Relic is the only SaaS-based application performance monitoring >> >>>> service >> >>>> that delivers powerful full stack analytics. Optimize and monitor >> >>>> your >> >>>> browser, app, & servers with just a few lines of code. Try New Relic >> >>>> and get this awesome Nerd Life shirt! >> >>>> http://p.sf.net/sfu/newrelic_d2d_apr >> >>>> >> >>>> _______________________________________________ >> >>>> Csound-devel mailing list >> >>>> Csound-devel@lists.sourceforge.net >> >>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>> >> >>> >> >>> >> >>> >> >>> >> >>> ------------------------------------------------------------------------------ >> >>> Try New Relic Now & We'll Send You this Cool Shirt >> >>> New Relic is the only SaaS-based application performance monitoring >> >>> service >> >>> that delivers powerful full stack analytics. Optimize and monitor your >> >>> browser, app, & servers with just a few lines of code. Try New Relic >> >>> and get this awesome Nerd Life shirt! >> >>> http://p.sf.net/sfu/newrelic_d2d_apr >> >>> _______________________________________________ >> >>> Csound-devel mailing list >> >>> Csound-devel@lists.sourceforge.net >> >>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>> >> >> >> >> >> >> >> >> >> >> ------------------------------------------------------------------------------ >> >> Try New Relic Now & We'll Send You this Cool Shirt >> >> New Relic is the only SaaS-based application performance monitoring >> >> service >> >> that delivers powerful full stack analytics. Optimize and monitor your >> >> browser, app, & servers with just a few lines of code. Try New Relic >> >> and get this awesome Nerd Life shirt! >> >> http://p.sf.net/sfu/newrelic_d2d_apr >> >> _______________________________________________ >> >> Csound-devel mailing list >> >> Csound-devel@lists.sourceforge.net >> >> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >> >> > >> > >> > >> > ------------------------------------------------------------------------------ >> > Try New Relic Now & We'll Send You this Cool Shirt >> > New Relic is the only SaaS-based application performance monitoring >> > service >> > that delivers powerful full stack analytics. Optimize and monitor your >> > browser, app, & servers with just a few lines of code. Try New Relic >> > and get this awesome Nerd Life shirt! >> > http://p.sf.net/sfu/newrelic_d2d_apr >> > _______________________________________________ >> > Csound-devel mailing list >> > Csound-devel@lists.sourceforge.net >> > https://lists.sourceforge.net/lists/listinfo/csound-devel >> > >> >> >> ------------------------------------------------------------------------------ >> Try New Relic Now & We'll Send You this Cool Shirt >> New Relic is the only SaaS-based application performance monitoring >> service >> that delivers powerful full stack analytics. Optimize and monitor your >> browser, app, & servers with just a few lines of code. Try New Relic >> and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr >> _______________________________________________ >> Csound-devel mailing list >> Csound-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/csound-devel > > > > > -- > codehop.com \| #code #art #music > > ------------------------------------------------------------------------------ > Try New Relic Now & We'll Send You this Cool Shirt > New Relic is the only SaaS-based application performance monitoring service > that delivers powerful full stack analytics. Optimize and monitor your > browser, app, & servers with just a few lines of code. Try New Relic > and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel > ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net

Date	2013-04-27 01:21
From	Andres Cabrera
Subject	Re: [Cs-dev] API docs
Attachments	None None
	Hmm... Maybe the documentation could be copied to the cpp file once the API stabilizes. I think having language specific API docs can help adoption. Cheers, Andrés On Fri, Apr 26, 2013 at 12:34 PM, Steven Yi <stevenyi@gmail.com> wrote: I found that there is a doxy2swig.py script: http://wrapitk.googlecode.com/svn-history/r539/trunk/Languages/Doc/doxy2swig.py that seems to popup on google. I tried modifying Doxyfile to generate xml, then running this script, then adding an %include to the python_interface.i in interfaces folder. It worked, but the results were not what I would have wanted. The issue is that the documentation is done mostly on the C functions, not on the include/csound.hpp file. It's that class in csound.hpp that is used to generate the Csound class used in Python/Java/etc. I think if we wanted to to use the above, we'd have to document the methods in include/csound.hpp. On Fri, Apr 26, 2013 at 7:26 PM, Jacob Joaquin <jacobjoaquin@gmail.com> wrote: > Here's an IPython tip that's really helping me get around csnd6 right now. > It comes with insanely awesome autocomplete features. So if I have this: > > In [8]: import csnd6 > > In [9]: c = csnd6 > > And I do a <tab> after c.MyfltVector, it brings up this: > > In [10]: c.MyfltVector. > c.MyfltVector.append c.MyfltVector.capacity > c.MyfltVector.erase c.MyfltVector.iterator > c.MyfltVector.push_back c.MyfltVector.resize > c.MyfltVector.assign c.MyfltVector.clear > c.MyfltVector.front c.MyfltVector.mro > c.MyfltVector.rbegin c.MyfltVector.size > c.MyfltVector.back c.MyfltVector.empty > c.MyfltVector.get_allocator c.MyfltVector.pop c.MyfltVector.rend > c.MyfltVector.swap > c.MyfltVector.begin c.MyfltVector.end > c.MyfltVector.insert c.MyfltVector.pop_back > c.MyfltVector.reserve > > I can also bring up the code for the MyfltVector class with: > > c.MyfltVector?? > > With docstrings were generated, it'd even be a bigger help. > > > On Fri, Apr 26, 2013 at 11:14 AM, Steven Yi <stevenyi@gmail.com> wrote: >> >> +1 to finding a way to get doxygen docs generated into the SWIG >> bindings. It'd be extremely helpful when using python to just do >> "dir(csnd6.Csound)" and help(csnd6.Csound.someMethod). >> >> On Fri, Apr 26, 2013 at 6:57 PM, Andres Cabrera <mantaraya36@gmail.com> >> wrote: >> > Sorry, I don't know if this is possible with doxygen. Does swig offer >> > any >> > documentation functionality? It would be nice if it could take the c >> > doxygen >> > and use it for the other language bindings it produces... >> > >> > Cheers, >> > Andrés >> > >> > >> > On Fri, Apr 26, 2013 at 10:30 AM, Rory Walsh <rorywalsh@ear.ie> wrote: >> >> >> >> It seems that there are more and more examples being written about new >> >> features, in various languages. Is it possible to include these in the >> >> API >> >> docs? Including them in csound.h, as discussed previously will really >> >> bloat >> >> that file. I don't know doxygen well enough, but is there a way that a >> >> new >> >> tab can be added to the API docs that would display files in the same >> >> way >> >> csound.h is currently displayed? We could then include some nice >> >> informed >> >> examples with the API docs. It would also be nice to have doxygen >> >> generated >> >> docs for Python and Java to, but one thing at a time. Any thoughts? >> >> Would >> >> this be possible with doxygen? I certainly don't mind contributing >> >> examples >> >> in C/C++. I just don't know if they should go into csound.h... >> >> >> >> >> >> On 25 April 2013 00:17, Andres Cabrera <mantaraya36@gmail.com> wrote: >> >>> >> >>> Thanks. Fixed. Will commit soon. >> >>> >> >>> >> >>> On Wed, Apr 24, 2013 at 11:15 AM, Rory Walsh <rorywalsh@ear.ie> wrote: >> >>>> >> >>>> it seems that the text describing the API function >> >>>> csoundListChannels() >> >>>> is still based on Csound 5. It makes mention of the >> >>>> CsoundChannelListEntry >> >>>> structure which I believe is now no longer available? >> >>>> >> >>>> >> >>>> On 18 April 2013 23:26, Victor Lazzarini <Victor.Lazzarini@nuim.ie> >> >>>> wrote: >> >>>>> >> >>>>> Some plugins (like the IO ones) actually use them. See in >> >>>>> Top/csmodule.c (csoundLoadExternal()) how they are called. >> >>>>> >> >>>>> On 18 Apr 2013, at 23:00, Andres Cabrera wrote: >> >>>>> >> >>>>> Thanks for the info Victor. Will commit the change soon. So these >> >>>>> functions are optional, which is good. I'm just curious, how is that >> >>>>> handled >> >>>>> technically, since the functions are in the header? >> >>>>> >> >>>>> Cheers, >> >>>>> Andrés >> >>>>> >> >>>>> >> >>>>> On Thu, Apr 18, 2013 at 7:12 AM, Victor Lazzarini >> >>>>> <Victor.Lazzarini@nuim.ie> wrote: >> >>>>>> >> >>>>>> Andres, >> >>>>>> >> >>>>>> csdl.h: the LINKAGE macro is sufficient, there is no need to call >> >>>>>> these csoundModuleCreate(), csoundModuleInit() and >> >>>>>> csoundModuleDestroy(). >> >>>>>> >> >>>>>> Regards >> >>>>>> >> >>>>>> Victor >> >>>>>> >> >>>>>> On 18 Apr 2013, at 05:28, Andres Cabrera wrote: >> >>>>>> >> >>>>>> > Hi, >> >>>>>> > >> >>>>>> > I've added some more documentation for the API. I'd appreciate a >> >>>>>> > look >> >>>>>> > particularly to csdl.h, as I'm not sure I got it right. >> >>>>>> > >> >>>>>> > http://csound.sourceforge.net/doc/html/index.html >> >>>>>> > >> >>>>>> > Cheers, >> >>>>>> > Andrés >> >>>>>> > >> >>>>>> > >> >>>>>> > >> >>>>>> > ------------------------------------------------------------------------------ >> >>>>>> > Precog is a next-generation analytics platform capable of >> >>>>>> > advanced >> >>>>>> > analytics on semi-structured data. The platform includes APIs for >> >>>>>> > building >> >>>>>> > apps and a phenomenal toolset for data science. Developers can >> >>>>>> > use >> >>>>>> > our toolset for easy data analysis & visualization. Get a free >> >>>>>> > account! >> >>>>>> > http://www2.precog.com/precogplatform/slashdotnewsletter >> >>>>>> > _______________________________________________ >> >>>>>> > Csound-devel mailing list >> >>>>>> > Csound-devel@lists.sourceforge.net >> >>>>>> > https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>>> >> >>>>>> Dr Victor Lazzarini >> >>>>>> Senior Lecturer >> >>>>>> Dept. of Music >> >>>>>> NUI Maynooth Ireland >> >>>>>> tel.: +353 1 708 3545 >> >>>>>> Victor dot Lazzarini AT nuim dot ie >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> >> >>>>>> ------------------------------------------------------------------------------ >> >>>>>> Precog is a next-generation analytics platform capable of advanced >> >>>>>> analytics on semi-structured data. The platform includes APIs for >> >>>>>> building >> >>>>>> apps and a phenomenal toolset for data science. Developers can use >> >>>>>> our toolset for easy data analysis & visualization. Get a free >> >>>>>> account! >> >>>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >> >>>>>> _______________________________________________ >> >>>>>> Csound-devel mailing list >> >>>>>> Csound-devel@lists.sourceforge.net >> >>>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> ------------------------------------------------------------------------------ >> >>>>> Precog is a next-generation analytics platform capable of advanced >> >>>>> analytics on semi-structured data. The platform includes APIs for >> >>>>> building >> >>>>> apps and a phenomenal toolset for data science. Developers can use >> >>>>> our toolset for easy data analysis & visualization. Get a free >> >>>>> account! >> >>>>> >> >>>>> >> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter_______________________________________________ >> >>>>> Csound-devel mailing list >> >>>>> Csound-devel@lists.sourceforge.net >> >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>> >> >>>>> >> >>>>> Dr Victor Lazzarini >> >>>>> Senior Lecturer >> >>>>> Dept. of Music >> >>>>> NUI Maynooth Ireland >> >>>>> tel.: +353 1 708 3545 >> >>>>> Victor dot Lazzarini AT nuim dot ie >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> >> >>>>> ------------------------------------------------------------------------------ >> >>>>> Precog is a next-generation analytics platform capable of advanced >> >>>>> analytics on semi-structured data. The platform includes APIs for >> >>>>> building >> >>>>> apps and a phenomenal toolset for data science. Developers can use >> >>>>> our toolset for easy data analysis & visualization. Get a free >> >>>>> account! >> >>>>> http://www2.precog.com/precogplatform/slashdotnewsletter >> >>>>> _______________________________________________ >> >>>>> Csound-devel mailing list >> >>>>> Csound-devel@lists.sourceforge.net >> >>>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>>> >> >>>> >> >>>> >> >>>> >> >>>> >> >>>> ------------------------------------------------------------------------------ >> >>>> Try New Relic Now & We'll Send You this Cool Shirt >> >>>> New Relic is the only SaaS-based application performance monitoring >> >>>> service >> >>>> that delivers powerful full stack analytics. Optimize and monitor >> >>>> your >> >>>> browser, app, & servers with just a few lines of code. Try New Relic >> >>>> and get this awesome Nerd Life shirt! >> >>>> http://p.sf.net/sfu/newrelic_d2d_apr >> >>>> >> >>>> _______________________________________________ >> >>>> Csound-devel mailing list >> >>>> Csound-devel@lists.sourceforge.net >> >>>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>>> >> >>> >> >>> >> >>> >> >>> >> >>> ------------------------------------------------------------------------------ >> >>> Try New Relic Now & We'll Send You this Cool Shirt >> >>> New Relic is the only SaaS-based application performance monitoring >> >>> service >> >>> that delivers powerful full stack analytics. Optimize and monitor your >> >>> browser, app, & servers with just a few lines of code. Try New Relic >> >>> and get this awesome Nerd Life shirt! >> >>> http://p.sf.net/sfu/newrelic_d2d_apr >> >>> _______________________________________________ >> >>> Csound-devel mailing list >> >>> Csound-devel@lists.sourceforge.net >> >>> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >>> >> >> >> >> >> >> >> >> >> >> ------------------------------------------------------------------------------ >> >> Try New Relic Now & We'll Send You this Cool Shirt >> >> New Relic is the only SaaS-based application performance monitoring >> >> service >> >> that delivers powerful full stack analytics. Optimize and monitor your >> >> browser, app, & servers with just a few lines of code. Try New Relic >> >> and get this awesome Nerd Life shirt! >> >> http://p.sf.net/sfu/newrelic_d2d_apr >> >> _______________________________________________ >> >> Csound-devel mailing list >> >> Csound-devel@lists.sourceforge.net >> >> https://lists.sourceforge.net/lists/listinfo/csound-devel >> >> >> > >> > >> > >> > ------------------------------------------------------------------------------ >> > Try New Relic Now & We'll Send You this Cool Shirt >> > New Relic is the only SaaS-based application performance monitoring >> > service >> > that delivers powerful full stack analytics. Optimize and monitor your >> > browser, app, & servers with just a few lines of code. Try New Relic >> > and get this awesome Nerd Life shirt! >> > http://p.sf.net/sfu/newrelic_d2d_apr >> > _______________________________________________ >> > Csound-devel mailing list >> > Csound-devel@lists.sourceforge.net >> > https://lists.sourceforge.net/lists/listinfo/csound-devel >> > >> >> >> ------------------------------------------------------------------------------ >> Try New Relic Now & We'll Send You this Cool Shirt >> New Relic is the only SaaS-based application performance monitoring >> service >> that delivers powerful full stack analytics. Optimize and monitor your >> browser, app, & servers with just a few lines of code. Try New Relic >> and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr >> _______________________________________________ >> Csound-devel mailing list >> Csound-devel@lists.sourceforge.net >> https://lists.sourceforge.net/lists/listinfo/csound-devel > > > > > -- > codehop.com \| #code #art #music > > ------------------------------------------------------------------------------ > Try New Relic Now & We'll Send You this Cool Shirt > New Relic is the only SaaS-based application performance monitoring service > that delivers powerful full stack analytics. Optimize and monitor your > browser, app, & servers with just a few lines of code. Try New Relic > and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr > _______________________________________________ > Csound-devel mailing list > Csound-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/csound-devel > ------------------------------------------------------------------------------ Try New Relic Now & We'll Send You this Cool Shirt New Relic is the only SaaS-based application performance monitoring service that delivers powerful full stack analytics. Optimize and monitor your browser, app, & servers with just a few lines of code. Try New Relic and get this awesome Nerd Life shirt! http://p.sf.net/sfu/newrelic_d2d_apr _______________________________________________ Csound-devel mailing list Csound-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/csound-devel