I would be speaking for myselft but, that would be a great thing to have Jan... In that way we can make it easier for people joining the band to generate comprehensive documentation that looks the same across plugins, thus, making it more accesible for the rest...
On 10/30/08, Jan Kassens <[EMAIL PROTECTED]> wrote: > > > i'll see if i can script a small ruby thing to read markdown from javadoc > like comments, i think that could be quite a nice idea for people who like > it (and a chance for me to get a bit more into ruby again :P ) > > -jan > > On Oct 30, 2008, at 18:41, Iván N Paz wrote: > > Thanks for answering back Jan... >> >> I was wondering if there was smth like a parser that reads the >> Comments that start each class or function (just like phpDocumentor) >> and generates som MarkDown that you can improve later... if not, what >> the h3ck... its not that hard after all ;-) >> >> >> >> On 10/30/08, Jan Kassens <[EMAIL PROTECTED]> wrote: >> >>> >>> The javascript language is _very_ dynamic, and because of that there is >>> no >>> proper way of programatically searching for the functions. >>> Thats also one of the reasons we switched from inline NaturalDocs >>> (javadocs >>> like, naturaldocs.org) to external markdown docs. (think of >>> auto-generated >>> functions, things like Selectors etc). >>> >>> I think plugin developers can use whatever doc system they like. >>> >>> jan >>> >>> >>> On Oct 30, 2008, at 15:59, Iván N Paz wrote: >>> >>> >>> @nathan: >>>> Thats for mootools syntax highlight, I think VuuRWerk was asking for a >>>> doc parser (like when you use phpDocumentor or the like) >>>> >>>> @Jan: >>>> I feared that :-P >>>> >>>> Excuse my ignorance on this, but about that aspect.. do you consider >>>> bad-practice if plugin developers use another type of approach to >>>> generate API doc for their plugins (such as phpDocumentor) or do you >>>> advise to use MarkDown as well? >>>> >>>> Is the markdown system able to parse source files to generate a basic >>>> skeleton that you can further improve later? >>>> >>>> Greetings >>>> Iván >>>> >>>> On 10/30/08, Jan Kassens <[EMAIL PROTECTED]> wrote: >>>> >>>> >>>>> we're using seperate markdown files and a markdown parser to generate >>>>> >>>> the >>> >>>> docs. >>>>> >>>>> example: -> >>>>> >>>>> >>> http://github.com/mootools/mootools-core/tree/master/Docs/Fx/Fx.Tween.md >>> >>>> >>>>> >>>>> On Oct 30, 2008, at 15:23, Iván N Paz wrote: >>>>> >>>>> >>>>> >>>>> How do mootools developers generate the docs? by hand? Or do they use >>>>>> certain parser to create the 1st skeleton, then enhance it with more >>>>>> info, examples, etc? >>>>>> >>>>>> @electrobender: >>>>>> What was the name of the DW plugin/extension? >>>>>> >>>>>> >>>>>> On 10/30/08, electronbender <[EMAIL PROTECTED]> wrote: >>>>>> >>>>>> >>>>>> >>>>>>> Wasnt there a plugin for dreamweaver? >>>>>>> >>>>>>> >>>>>>> On Oct 28, 9:48 pm, VuuRWerK <[EMAIL PROTECTED]> wrote: >>>>>>> >>>>>>> >>>>>>> hi folks, >>>>>>>> >>>>>>>> knows anybody a doc-tool which can parse mootools classes? >>>>>>>> Particularly the options and methods part? I've tried a lot of >>>>>>>> >>>>>>> tools >>> >>>> which support the namespaces of MochaKit or YUI. I also tried the >>>>>>>> script-doc in aptana ... works only with namepsaces :( >>>>>>>> I've documented all my classes, methods and properties (options) >>>>>>>> >>>>>>> with >>> >>>> javadoc tags so far i hope this could be considered. >>>>>>>> >>>>>>>> I hope anyone can help me :) >>>>>>>> >>>>>>>> Greetings, VuuRWerK >>>>>>>> >>>>>>>> >>>>>>>> >>>>>>> >>>>>>> >>>>>> >>>>>> -- >>>>>> >>>>>> ◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦ >>> >>>> Ivanicus' Code Box >>>>>> http://ivanicus.com/ >>>>>> >>>>>> >>>>>> >>>>> -- >>>>> twitter/blog: http://kassens.net >>>>> >>>>> >>>>> >>>>> >>>> >>>> -- >>>> ◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦ >>>> Ivanicus' Code Box >>>> http://ivanicus.com/ >>>> >>>> >>> -- >>> twitter/blog: http://kassens.net >>> >>> >>> >> >> -- >> ◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦ >> Ivanicus' Code Box >> http://ivanicus.com/ >> > > -- > twitter/blog: http://kassens.net > > -- ◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦ Ivanicus' Code Box http://ivanicus.com/
