Helma Logo
main list history

Version 7 by tobi on 25. November 2005, 14:58

7as a start i attached a <a href="http://dev.helma.org/static/helma.dev/Wiki/suggestion%20for%20helma%20user%20documentation/hopdocs%20exampledev/Wiki/suggestion%20for%20helma%20user%20documentation/hopdocs.zip">zip file</a> containing some source files and the generated documentation: it's the hopobject class as well as the res and app objects, all of them with a few fields and methods. the documentation was copied from helma.org.

Version 6 by tobi on 25. November 2005, 14:47

13but first of all: what do you think? (*tobi*)// *tobi*

Version 5 by tobi on 25. November 2005, 14:47

13but first of all: what do you think? [*tobi*](*tobi*)

Version 4 by tobi on 25. November 2005, 14:47

13but first of all: what do you think? *tobi*[*tobi*]

Version 3 by tobi on 25. November 2005, 14:46

13but first of all: what do you think?think? *tobi*
14

Version 2 by tobi on 25. November 2005, 14:43

7as a start i included attached a zip file <a href="http://dev.helma.org/static/helma.dev/Wiki/suggestion%20for%20helma%20user%20documentation/hopdocs%20example.zip">zip file</a> containing some source files and the generated documentation: it's the hopobject class as well as the res and app objects, all of them with a few fields and methods. the documentation was copied from helma.org.

Version 1 by tobi on 25. November 2005, 14:41

1since i am busily working with jsdoc right now, i found a neat way how you could create really excellent documentation of helma's javascript features and potentially replace the current reference with the result.
2
3since jsdoc doesn't make any syntax and almost no consistency checks you simply could document any of the available helma-only objects as pseudo-javascript code.
4
5in consequence, users would have an excellent way to browse through helma's object model and methods. moreover, developers could simply drop these pseudo-code files into their own apps and thus include the whole helma documentation with their own jsdoc-generated output.
6
7as a start i included a zip file containing some source files and the generated documentation: it's the hopobject class as well as the res and app objects, all of them with a few fields and methods. the documentation was copied from helma.org.
8
9please take a look at the output and i hope you agree with me that so far this is the best way to show helma's javascript features -- especially if you already know javadoc!
10
11certainly, there can be added a lot more explanations and examples, and there has to be added all of the other classes, instances and their all of their fields and methods.
12
13but first of all: what do you think?