please review API update

classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

please review API update

Nathan Wolek-2
I uploaded the updated API documentation to a temporary location so that people could review it.  Please take a moment to look over the class list and let me know if you think it is ready to go live.

The new list:
http://jamoma.org/api-update/classes.html

The old list for comparison:
http://jamoma.org/api-documentation/classes.html

Protected methods and variables are now showing up in the list of the left.  If there are no comments in the code, it will still be missing from the panel on the right.  A good example is TTAudioMatrix.

It is still skipping files that do not define an actual, like TTUnitTest.  Still trying to figure that one out.

Let me know if you think this is ready to go public.

--Nathan


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel
Reply | Threaded
Open this post in threaded view
|

Re: please review API update

Timothy Place-2
Hi Nathan,

I just pushed a commit to the Doxyfile/etc. that starts to bring in some old narrative about the Jamoma API that I started writing several years ago.   I think the info is still relevant and potentially helpful.  It shows up in as the main page and also as "additional pages" in the left sidebar.

Most of the "chapters" are not formatted correctly and so they don't show up, look right, or cross-reference.  It should be easy to do though...  They are all in the form of "fake" header files in the "chapters" folder.  Textmate has a "Doxygen" bundle which might be useful when editing these files (or not).

HTH,
  Tim



On Wed, Sep 5, 2012 at 5:10 AM, Nathan Wolek <[hidden email]> wrote:
I uploaded the updated API documentation to a temporary location so that people could review it.  Please take a moment to look over the class list and let me know if you think it is ready to go live.

The new list:
http://jamoma.org/api-update/classes.html

The old list for comparison:
http://jamoma.org/api-documentation/classes.html

Protected methods and variables are now showing up in the list of the left.  If there are no comments in the code, it will still be missing from the panel on the right.  A good example is TTAudioMatrix.

It is still skipping files that do not define an actual, like TTUnitTest.  Still trying to figure that one out.

Let me know if you think this is ready to go public.

--Nathan


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel
Reply | Threaded
Open this post in threaded view
|

Re: please review API update

Nathan Wolek-2
On Sep 5, 2012, at 5:55 PM, Timothy Place <[hidden email]> wrote:
I just pushed a commit to the Doxyfile/etc. that starts to bring in some old narrative about the Jamoma API that I started writing several years ago.   I think the info is still relevant and potentially helpful.  It shows up in as the main page and also as "additional pages" in the left sidebar.

Most of the "chapters" are not formatted correctly and so they don't show up, look right, or cross-reference.  It should be easy to do though...  They are all in the form of "fake" header files in the "chapters" folder.  Textmate has a "Doxygen" bundle which might be useful when editing these files (or not).

After a few days working on some other things, I came back to this yesterday and today.  I have the formatting fixes pushed to GitHub and the pages are now live on the server.  Take a look and let me know what you think.


Cheers.
--Nathan

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel
Reply | Threaded
Open this post in threaded view
|

Re: please review API update

Trond Lossius
Administrator
Thanks a lot, Nathan!

This is really, really useful for all of us.

Cheers,
Trond


On Sep 13, 2012, at 3:50 PM, Nathan Wolek <[hidden email]> wrote:

> On Sep 5, 2012, at 5:55 PM, Timothy Place <[hidden email]> wrote:
>> I just pushed a commit to the Doxyfile/etc. that starts to bring in some old narrative about the Jamoma API that I started writing several years ago.   I think the info is still relevant and potentially helpful.  It shows up in as the main page and also as "additional pages" in the left sidebar.
>>
>> Most of the "chapters" are not formatted correctly and so they don't show up, look right, or cross-reference.  It should be easy to do though...  They are all in the form of "fake" header files in the "chapters" folder.  Textmate has a "Doxygen" bundle which might be useful when editing these files (or not).
>
> After a few days working on some other things, I came back to this yesterday and today.  I have the formatting fixes pushed to GitHub and the pages are now live on the server.  Take a look and let me know what you think.
>
> http://jamoma.org/api-documentation/index.html
>
> Cheers.
> --Nathan

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel
Reply | Threaded
Open this post in threaded view
|

Re: please review API update

Nils Peters
On 12-09-13 1:48 PM, Trond Lossius wrote:
> Thanks a lot, Nathan!
>
> This is really, really useful for all of us.

I second that!

Thanks a lot,

Nils



------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel
Reply | Threaded
Open this post in threaded view
|

Re: please review API update

Théo de la Hogue
Le 13 sept. 2012 à 23:46, Nils Peters a écrit :

Thanks a lot, Nathan!

This is really, really useful for all of us.

I second that!

Thanks a lot,

Nils

+3 !

TO

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel
Reply | Threaded
Open this post in threaded view
|

Re: please review API update

Timothy Place
In reply to this post by Nathan Wolek-2
Thanks for taking the time to clean this up, Nathan!

best,
  Tim



On Thu, Sep 13, 2012 at 8:50 AM, Nathan Wolek <[hidden email]> wrote:
On Sep 5, 2012, at 5:55 PM, Timothy Place <[hidden email]> wrote:
I just pushed a commit to the Doxyfile/etc. that starts to bring in some old narrative about the Jamoma API that I started writing several years ago.   I think the info is still relevant and potentially helpful.  It shows up in as the main page and also as "additional pages" in the left sidebar.

Most of the "chapters" are not formatted correctly and so they don't show up, look right, or cross-reference.  It should be easy to do though...  They are all in the form of "fake" header files in the "chapters" folder.  Textmate has a "Doxygen" bundle which might be useful when editing these files (or not).

After a few days working on some other things, I came back to this yesterday and today.  I have the formatting fixes pushed to GitHub and the pages are now live on the server.  Take a look and let me know what you think.


Cheers.
--Nathan

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel



------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel
Reply | Threaded
Open this post in threaded view
|

Re: please review API update

Nathan Wolek-2
In reply to this post by Théo de la Hogue
No problem guys.  Still a bit a work to be done in revealing things defined outside a class declaration, but it is certainly in a better state now.
--Nathan

On Sep 13, 2012, at 11:51 PM, Théo de la Hogue <[hidden email]> wrote:

Le 13 sept. 2012 à 23:46, Nils Peters a écrit :

Thanks a lot, Nathan!

This is really, really useful for all of us.

I second that!

Thanks a lot,

Nils

+3 !

TO


------------------------------------------------------------------------------
Got visibility?
Most devs has no idea what their production app looks like.
Find out how fast your code is with AppDynamics Lite.
http://ad.doubleclick.net/clk;262219671;13503038;y?
http://info.appdynamics.com/FreeJavaPerformanceDownload.html
_______________________________________________
Jamoma-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/jamoma-devel