First of all, a big thanks to all developpers that have contributed to Prototype. Great work! Regarding my request, I have developped my own ''framework'' based over Prototype (class inheritance, etc...) in order to suit our application needs and to ease javascript scripting for our web developpers. Further, I want to all the classes and methods in this framework in order to generate the documentation (something like a ''JSDOC'') of all this work (maybe this framework will be published one day). I tried the interesting NaturalDocs (http://www.naturaldocs.org) documentation generator but it seems not to be so powerfull to generate documentation from classes based on Prototype. Can someone tell how the prototype team generates his documentation as we can see on the Prototype API documentation page (http:// prototypejs.org/api/)? Or do you know some program that is able to generate prototype based documentation? Thanks a lot! --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Spinoffs" group. To post to this group, send email to rubyonrails-spinoffs-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-spinoffs-unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-spinoffs?hl=en -~----------~----~----~----~------~----~------~--~---
Check out this thread over in Prototype Core: http://groups.google.com/group/prototype-core/browse_thread/thread/c2fb39006577bf4b -- T.J. Crowder tj / crowder software / com On Apr 3, 1:46 pm, almeidap <almei...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> First of all, a big thanks to all developpers that have contributed to > Prototype. Great work! > > Regarding my request, I have developped my own ''framework'' based over > Prototype (class inheritance, etc...) in order to suit our application > needs and to ease javascript scripting for our web developpers. > > Further, I want to all the classes and methods in this framework in > order to generate the documentation (something like a ''JSDOC'') of all > this work (maybe this framework will be published one day). > > I tried the interesting NaturalDocs (http://www.naturaldocs.org) > documentation generator but it seems not to be so powerfull to > generate documentation from classes based on Prototype. > > Can someone tell how the prototype team generates his documentation as > we can see on the Prototype API documentation page (http:// > prototypejs.org/api/)? Or do you know some program that is able to > generate prototype based documentation? > > Thanks a lot!--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Spinoffs" group. To post to this group, send email to rubyonrails-spinoffs-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-spinoffs-unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-spinoffs?hl=en -~----------~----~----~----~------~----~------~--~---
Thanks for the hint Crowder. What is PDoc exactly? I browsed the web for some documentation (metadocumentation? :) ) or web site but found only a forgotten project (http://pdoc.sourceforge.net/). The current trunk in the SVN doesn''t contains complete guide/ documentation or any interesting example so I will keep NaturalDocs for documentation generation. If anyone has another proposition for documentation generation, could be usefull. On 3 avr, 15:44, "T.J. Crowder" <tjcrow...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> Check out this thread over in Prototype Core:http://groups.google.com/group/prototype-core/browse_thread/thread/c2... > -- > T.J. Crowder > tj / crowder software / com > > On Apr 3, 1:46 pm, almeidap <almei...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote: > > > First of all, a big thanks to all developpers that have contributed to > > Prototype. Great work! > > > Regarding my request, I have developped my own ''framework'' based over > > Prototype (class inheritance, etc...) in order to suit our application > > needs and to ease javascript scripting for our web developpers. > > > Further, I want to all the classes and methods in this framework in > > order to generate the documentation (something like a ''JSDOC'') of all > > this work (maybe this framework will be published one day). > > > I tried the interesting NaturalDocs (http://www.naturaldocs.org) > > documentation generator but it seems not to be so powerfull to > > generate documentation from classes based on Prototype. > > > Can someone tell how the prototype team generates his documentation as > > we can see on the Prototype API documentation page (http:// > > prototypejs.org/api/)? Or do you know some program that is able to > > generate prototype based documentation? > > > Thanks a lot!--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Spinoffs" group. To post to this group, send email to rubyonrails-spinoffs-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-spinoffs-unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-spinoffs?hl=en -~----------~----~----~----~------~----~------~--~---
Hi, PDoc is currently in alpha. A beta release should be announced in the upcoming weeks. Best, Tobie On Apr 3, 5:19 pm, almeidap <almei...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> Thanks for the hint Crowder. What is PDoc exactly? I browsed the web > for some documentation (metadocumentation? :) ) or web site but found > only a forgotten project (http://pdoc.sourceforge.net/). > > The current trunk in the SVN doesn''t contains complete guide/ > documentation or any interesting example so I will keep NaturalDocs > for documentation generation. > > If anyone has another proposition for documentation generation, could > be usefull. > > On 3 avr, 15:44, "T.J. Crowder" <tjcrow...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote: > > > Check out this thread over in Prototype Core:http://groups.google.com/group/prototype-core/browse_thread/thread/c2... > > -- > > T.J. Crowder > > tj / crowder software / com > > > On Apr 3, 1:46 pm, almeidap <almei...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote: > > > > First of all, a big thanks to all developpers that have contributed to > > > Prototype. Great work! > > > > Regarding my request, I have developped my own ''framework'' based over > > > Prototype (class inheritance, etc...) in order to suit our application > > > needs and to ease javascript scripting for our web developpers. > > > > Further, I want to all the classes and methods in this framework in > > > order to generate the documentation (something like a ''JSDOC'') of all > > > this work (maybe this framework will be published one day). > > > > I tried the interesting NaturalDocs (http://www.naturaldocs.org) > > > documentation generator but it seems not to be so powerfull to > > > generate documentation from classes based on Prototype. > > > > Can someone tell how the prototype team generates his documentation as > > > we can see on the Prototype API documentation page (http:// > > > prototypejs.org/api/)? Or do you know some program that is able to > > > generate prototype based documentation? > > > > Thanks a lot!--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Spinoffs" group. To post to this group, send email to rubyonrails-spinoffs-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-spinoffs-unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-spinoffs?hl=en -~----------~----~----~----~------~----~------~--~---
We''ll be setting up a doc task force as soon as PDoc is in beta. We''ll be posting about this very soon. And Ken, your help will be much appreciated. Best, Tobie On Apr 3, 8:51 pm, Ken Snyder <kendsny...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> I am the one working on adding comments prototype. My focus is on > commenting the internals of functions, but I did decide to use PDoc to > document each function. You can see my progress here:http://dev.rubyonrails.org/ticket/11368. I invite others to update the > diff''s I''ve already submitted to clarify or rewrite some of the comments > I''ve already done. > > I decided to use PDoc because it is concise and is the most easily > readable to a casual browser of the source code. My idea is to update > the rake function included in the source to strip the comments by > default but optionally preserve them. I''m thinking that others who want > code completion from visual studio or a javadoc reader should take one > of two paths: > (a) write a script to convert the PDoc comments into another format > (b) port comments into the source code directly from prototypejs.org/api/ > > Tobie, is your idea to use a PDoc version of the source code to generate > the content of prototypejs.org/api/? If not, someone may be interested > in writing a script that takes the contents of prototypejs.org/api/ and > adds them into the source programmatically--attacking the problem from > the opposite angle, if you will. Right now I''m describing the functions > as if you have the source in front of you, so instead of the > prototypejs.org/api/ approach of "here is the use of this function" my > approach is "the function processes inputs this way and gives outputs > this way." > > My feeling is that the comments can''t be everything to everyone, but > perhaps we can automate it to generate different versions. Regardless, > as I mentioned my focus is commenting on the internals of functions. I > think comments inside of functions will be compatible with any official > decisions on generating documentation or supporting code completion. > > Any thoughts are welcomed. > > Thanks, > > Ken Snyder > > Tobie Langel wrote: > > Hi, > > > PDoc is currently in alpha. A beta release should be announced in the > > upcoming weeks. > > > Best, > > > Tobie--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Spinoffs" group. To post to this group, send email to rubyonrails-spinoffs-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-spinoffs-unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-spinoffs?hl=en -~----------~----~----~----~------~----~------~--~---