Csound Csound-dev Csound-tekno Search About

[Cs-dev] API documentation

Date2014-08-14 21:10
Fromjpff
Subject[Cs-dev] API documentation
I seem to remember there was a document describing the API
(Java/Android in particular) but I cannot find it.  What is it called
and where is it?
==John ffitch

------------------------------------------------------------------------------
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2014-08-14 21:12
FromVictor Lazzarini
SubjectRe: [Cs-dev] API documentation
Do you mean this one?

http://csound.github.io/docs/api/index.html
========================
Dr Victor Lazzarini
Senior Lecturer
NUI Maynooth, Ireland
victor dot lazzarini at nuim dot ie




On 14 Aug 2014, at 21:10, jpff  wrote:

> I seem to remember there was a document describing the API
> (Java/Android in particular) but I cannot find it.  What is it called
> and where is it?
> ==John ffitch
> 
> ------------------------------------------------------------------------------
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel


------------------------------------------------------------------------------
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2014-08-14 21:17
Fromjpff@cs.bath.ac.uk
SubjectRe: [Cs-dev] API documentation
AttachmentsNone  

Date2014-08-14 21:29
FromVictor Lazzarini
SubjectRe: [Cs-dev] API documentation
I can’t help much with Java, but if you’d like examples in Python or C, I might be able to
help.

Did the API examples in github not help?
========================
Dr Victor Lazzarini
Senior Lecturer
NUI Maynooth, Ireland
victor dot lazzarini at nuim dot ie




On 14 Aug 2014, at 21:17, jpff@cs.bath.ac.uk wrote:

> May have been that document; it gives me no idea what the java methods  
> are though.
> 
> I am finding it extremely hard to actually use the API; every attempt  
> and language has failed so far.
>   Oh well
> ==John ff
> Quoting Victor Lazzarini :
> 
>> Do you mean this one?
>> 
>> http://csound.github.io/docs/api/index.html
>> ========================
>> Dr Victor Lazzarini
>> Senior Lecturer
>> NUI Maynooth, Ireland
>> victor dot lazzarini at nuim dot ie
>> 
>> 
>> 
>> 
>> On 14 Aug 2014, at 21:10, jpff  wrote:
>> 
>>> I seem to remember there was a document describing the API
>>> (Java/Android in particular) but I cannot find it.  What is it called
>>> and where is it?
>>> ==John ffitch
>>> 
>>> ------------------------------------------------------------------------------
>>> _______________________________________________
>>> Csound-devel mailing list
>>> Csound-devel@lists.sourceforge.net
>>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>> 
>> 
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
> 
> 
> 
> 
> ------------------------------------------------------------------------------
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel


------------------------------------------------------------------------------
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2014-08-14 21:49
FromMichael Gogins
SubjectRe: [Cs-dev] API documentation
AttachmentsNone  None  

The Java ones are quite similar to the C++ ones.

Regards,
Mike

On Aug 14, 2014 4:17 PM, <jpff@cs.bath.ac.uk> wrote:
May have been that document; it gives me no idea what the java methods
are though.

I am finding it extremely hard to actually use the API; every attempt
and language has failed so far.
   Oh well
==John ff
Quoting Victor Lazzarini <Victor.Lazzarini@nuim.ie>:

> Do you mean this one?
>
> http://csound.github.io/docs/api/index.html
> ========================
> Dr Victor Lazzarini
> Senior Lecturer
> NUI Maynooth, Ireland
> victor dot lazzarini at nuim dot ie
>
>
>
>
> On 14 Aug 2014, at 21:10, jpff <jpff@cs.bath.ac.uk> wrote:
>
>> I seem to remember there was a document describing the API
>> (Java/Android in particular) but I cannot find it.  What is it called
>> and where is it?
>> ==John ffitch
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel




------------------------------------------------------------------------------
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/csound-devel

Date2014-08-14 22:13
FromSteven Yi
SubjectRe: [Cs-dev] API documentation
The src directory here may be useful:

https://github.com/csound/csoundAPI_examples/tree/master/java

On Thu, Aug 14, 2014 at 4:49 PM, Michael Gogins
 wrote:
> The Java ones are quite similar to the C++ ones.
>
> Regards,
> Mike
>
> On Aug 14, 2014 4:17 PM,  wrote:
>>
>> May have been that document; it gives me no idea what the java methods
>> are though.
>>
>> I am finding it extremely hard to actually use the API; every attempt
>> and language has failed so far.
>>    Oh well
>> ==John ff
>> Quoting Victor Lazzarini :
>>
>> > Do you mean this one?
>> >
>> > http://csound.github.io/docs/api/index.html
>> > ========================
>> > Dr Victor Lazzarini
>> > Senior Lecturer
>> > NUI Maynooth, Ireland
>> > victor dot lazzarini at nuim dot ie
>> >
>> >
>> >
>> >
>> > On 14 Aug 2014, at 21:10, jpff  wrote:
>> >
>> >> I seem to remember there was a document describing the API
>> >> (Java/Android in particular) but I cannot find it.  What is it called
>> >> and where is it?
>> >> ==John ffitch
>> >>
>> >>
>> >> ------------------------------------------------------------------------------
>> >> _______________________________________________
>> >> Csound-devel mailing list
>> >> Csound-devel@lists.sourceforge.net
>> >> https://lists.sourceforge.net/lists/listinfo/csound-devel
>> >
>> >
>> >
>> > ------------------------------------------------------------------------------
>> > _______________________________________________
>> > Csound-devel mailing list
>> > Csound-devel@lists.sourceforge.net
>> > https://lists.sourceforge.net/lists/listinfo/csound-devel
>>
>>
>>
>>
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>

------------------------------------------------------------------------------
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2014-08-14 22:28
FromAndres Cabrera
SubjectRe: [Cs-dev] API documentation
AttachmentsNone  None  
How do other projects handle this? Is there a way to generate documentation from SWIG + doxygen?

Cheers,
Andrés


On Thu, Aug 14, 2014 at 4:13 PM, Steven Yi <stevenyi@gmail.com> wrote:
The src directory here may be useful:

https://github.com/csound/csoundAPI_examples/tree/master/java

On Thu, Aug 14, 2014 at 4:49 PM, Michael Gogins
<michael.gogins@gmail.com> wrote:
> The Java ones are quite similar to the C++ ones.
>
> Regards,
> Mike
>
> On Aug 14, 2014 4:17 PM, <jpff@cs.bath.ac.uk> wrote:
>>
>> May have been that document; it gives me no idea what the java methods
>> are though.
>>
>> I am finding it extremely hard to actually use the API; every attempt
>> and language has failed so far.
>>    Oh well
>> ==John ff
>> Quoting Victor Lazzarini <Victor.Lazzarini@nuim.ie>:
>>
>> > Do you mean this one?
>> >
>> > http://csound.github.io/docs/api/index.html
>> > ========================
>> > Dr Victor Lazzarini
>> > Senior Lecturer
>> > NUI Maynooth, Ireland
>> > victor dot lazzarini at nuim dot ie
>> >
>> >
>> >
>> >
>> > On 14 Aug 2014, at 21:10, jpff <jpff@cs.bath.ac.uk> wrote:
>> >
>> >> I seem to remember there was a document describing the API
>> >> (Java/Android in particular) but I cannot find it.  What is it called
>> >> and where is it?
>> >> ==John ffitch
>> >>
>> >>
>> >> ------------------------------------------------------------------------------
>> >> _______________________________________________
>> >> Csound-devel mailing list
>> >> Csound-devel@lists.sourceforge.net
>> >> https://lists.sourceforge.net/lists/listinfo/csound-devel
>> >
>> >
>> >
>> > ------------------------------------------------------------------------------
>> > _______________________________________________
>> > Csound-devel mailing list
>> > Csound-devel@lists.sourceforge.net
>> > https://lists.sourceforge.net/lists/listinfo/csound-devel
>>
>>
>>
>>
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>

------------------------------------------------------------------------------
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/csound-devel


Date2014-08-14 23:19
FromSteven Yi
SubjectRe: [Cs-dev] API documentation
I did a quick search and found this:

http://swig.org/Doc3.0/Java.html#Java_javadoc_comments

"The SWIG documentation system is currently deprecated. When it is
resurrected JavaDoc comments will be fully supported. "

This is for SWIG 3.0.  It does look like there's some kind of
autodocumentation for Python:

http://swig.org/Doc3.0/Python.html#Python_nn67

which we already have in our python_interface.i.  (You can use
help(obj) to look up that documentation in Python REPL).

I think there isn't any standard way people are doing this. I just
googled and saw a mention of taking the doxygen xml output and doing
some scripting using that, but that seems a bit of work.

On Thu, Aug 14, 2014 at 5:28 PM, Andres Cabrera  wrote:
> How do other projects handle this? Is there a way to generate documentation
> from SWIG + doxygen?
>
> Cheers,
> Andrés
>
>
> On Thu, Aug 14, 2014 at 4:13 PM, Steven Yi  wrote:
>>
>> The src directory here may be useful:
>>
>> https://github.com/csound/csoundAPI_examples/tree/master/java
>>
>> On Thu, Aug 14, 2014 at 4:49 PM, Michael Gogins
>>  wrote:
>> > The Java ones are quite similar to the C++ ones.
>> >
>> > Regards,
>> > Mike
>> >
>> > On Aug 14, 2014 4:17 PM,  wrote:
>> >>
>> >> May have been that document; it gives me no idea what the java methods
>> >> are though.
>> >>
>> >> I am finding it extremely hard to actually use the API; every attempt
>> >> and language has failed so far.
>> >>    Oh well
>> >> ==John ff
>> >> Quoting Victor Lazzarini :
>> >>
>> >> > Do you mean this one?
>> >> >
>> >> > http://csound.github.io/docs/api/index.html
>> >> > ========================
>> >> > Dr Victor Lazzarini
>> >> > Senior Lecturer
>> >> > NUI Maynooth, Ireland
>> >> > victor dot lazzarini at nuim dot ie
>> >> >
>> >> >
>> >> >
>> >> >
>> >> > On 14 Aug 2014, at 21:10, jpff  wrote:
>> >> >
>> >> >> I seem to remember there was a document describing the API
>> >> >> (Java/Android in particular) but I cannot find it.  What is it
>> >> >> called
>> >> >> and where is it?
>> >> >> ==John ffitch
>> >> >>
>> >> >>
>> >> >>
>> >> >> ------------------------------------------------------------------------------
>> >> >> _______________________________________________
>> >> >> Csound-devel mailing list
>> >> >> Csound-devel@lists.sourceforge.net
>> >> >> https://lists.sourceforge.net/lists/listinfo/csound-devel
>> >> >
>> >> >
>> >> >
>> >> >
>> >> > ------------------------------------------------------------------------------
>> >> > _______________________________________________
>> >> > Csound-devel mailing list
>> >> > Csound-devel@lists.sourceforge.net
>> >> > https://lists.sourceforge.net/lists/listinfo/csound-devel
>> >>
>> >>
>> >>
>> >>
>> >>
>> >>
>> >> ------------------------------------------------------------------------------
>> >> _______________________________________________
>> >> Csound-devel mailing list
>> >> Csound-devel@lists.sourceforge.net
>> >> https://lists.sourceforge.net/lists/listinfo/csound-devel
>> >
>> >
>> >
>> > ------------------------------------------------------------------------------
>> >
>> > _______________________________________________
>> > Csound-devel mailing list
>> > Csound-devel@lists.sourceforge.net
>> > https://lists.sourceforge.net/lists/listinfo/csound-devel
>> >
>>
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Csound-devel mailing list
>> Csound-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/csound-devel
>
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>

------------------------------------------------------------------------------
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net
https://lists