Yes. Really the test provided was just a proof of concept about how easy or difficult could be write a custom javascript documentation tool in java. The problem here is make fit jsdoc with other custom plugin will not be easy, not by some technical reason but the configuration on the pom.xml can be unnecessary long.
I think dedicating just some days we can do something similar to the stuff we have on myfaces-builder-plugin. A parser that read javascript annotation doclets, build a model and use velocity to generate the documentation. In this point is up to you if you want to do it, or maybe you could have other different tasks where your knowledge and expertise can be more productive and just let this to me. Leonardo 2011/7/25 Werner Punz <[email protected]>: > I only can guess here since I dont know if jsdoc can generate jars, but my > assumption is that we have to roll our own custom plugin. > This is still less work than to write our own javascript doc parser > or to adjust an existing codebase. > > Werner > > > Am 25.07.11 18:26, schrieb Leonardo Uribe: >> >> Hi Werner >> >> Yes, I was expecting that. The problem is how to generate an artifact >> that should be attached to the pom.xml, so it is deployed on maven >> repo when is generated, without write a custom plugin. >> >> regards, >> >> Leonardo >> >> 2011/7/25 Werner Punz<[email protected]>: >>> >>> Hi Leo no just the plain html docs. >>> I have to check if we can generate a jar out of it, if not we probably >>> have to jar the stuff ourselves. >>> >>> >>> >>> Werner >>> >>> >>> Am 25.07.11 18:20, schrieb Leonardo Uribe: >>>> >>>> Hi Werner >>>> >>>> Does this strategy generates a .jar? >>>> >>>> regards, >>>> >>>> Leonardo Uribe >>>> >>>> 2011/7/25 Werner Punz<[email protected]>: >>>>> >>>>> Ok I have basically all patterns working, please revisit the link, you >>>>> can >>>>> see now the api, the runtime class (basically a namespace with a set of >>>>> functions) >>>>> and the _Lang.js class, a singleton delegate which delegates the >>>>> namespace. >>>>> The normal classes now should be no problem as well since they use >>>>> the same doc mechanics as the singleton objects. >>>>> >>>>> Again here is the link >>>>> >>>>> http://people.apache.org/~werpu/jsdoc/symbols/jsf.html >>>>> >>>>> Which means, I will rework the scripts first to allow jsdoc to compile >>>>> them >>>>> properly and then once done, I will integrate jsdoc properly into our >>>>> build >>>>> system. >>>>> >>>>> >>>>> Werner >>>>> >>>>> >>>>> >>>>> >>>>> Am 25.07.11 16:36, schrieb Werner Punz: >>>>>> >>>>>> Actually I am working on the impl classes so far it looks like I can >>>>>> pull it off the _Runtime.js can definitely be documented via jsdoc. >>>>>> The other classes which are more OO probably also can be mapped into >>>>>> our >>>>>> jsdocs. >>>>>> >>>>>> >>>>>> >>>>>> Am 25.07.11 15:35, schrieb Jakob Korherr: >>>>>>> >>>>>>> Very nice. Great job, Werner! >>>>>>> >>>>>>> Regards, >>>>>>> Jakob >>>>>>> >>>>>>> 2011/7/25 Werner Punz<[email protected]>: >>>>>>>> >>>>>>>> Hi everyone, I have started this week to work on the javascript >>>>>>>> documentation issues, so far I can cover our API classes pretty well >>>>>>>> with >>>>>>>> jsdoc. Only one minor code modification was needed to get it up and >>>>>>>> running. >>>>>>>> >>>>>>>> Here is a first rough result by using jsdoc on the API section: >>>>>>>> >>>>>>>> http://people.apache.org/~werpu/jsdoc/symbols/jsf.html >>>>>>>> >>>>>>>> Since my first goal simply was to get the api docs out I will merge >>>>>>>> this >>>>>>>> into our maven build and do the code adjustements as needed. >>>>>>>> To get jsdocs for the impl is a nice to have but not vital, since >>>>>>>> the >>>>>>>> impl >>>>>>>> classes should not be used anyway by the users. >>>>>>>> >>>>>>>> Werner >>>>>>>> >>>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>> >>>>>> >>>>>> >>>>> >>>>> >>>>> >>>> >>> >>> >>> >> > > >
