Menu

#2 Documentation for objects in Velocity templates

none
closed
nobody
None
5
2015-02-23
2007-11-04
usercho
No

Hi,

I use the plugin to generate documentation for my code and the plugin is doing really great job. With good templates the documentation looks perfect. But I'd like to know all methods and properties of the objects available in the templates.
I tried to find something in this project's CVS but I did not find anything useful. Is the source code available anywhere to download (if it's open source)?
I'm looking for some functionality that I do not find in the plugin. Maybe (if I was able) I could write it and send it back to the project.

Thanks

Discussion

  • Nobody/Anonymous

    Logged In: NO

    The code you are looking for was just recently added to the CVS, the package for context (template) objects is here:

    http://jsuml.cvs.sourceforge.net/jsuml/jsuml-core/src/org/jsuml/generator/

    We want to get some javadoc up for these at some point but right now if you look directly at the code you will see these are just thin wrappers around the eclipse UML2 model objects, made more convenient for templating.

    Currently the javadoc for the wrapped objects can be found here:
    http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.uml2.doc/references/javadoc/org/eclipse/uml2/uml/package-summary.html

    So if you see functionality you want to add to the context objects you can try writing a new wrapper method. If you're not able to, just describe the functionality here as a new support request and one of the developers will (eventually) take a look.

     
  • jhammen

    jhammen - 2015-02-23
    • status: open --> closed
    • Group: --> v1.0_(example)
     
  • jhammen

    jhammen - 2015-02-23

    The latest version 0.9 no longer uses wrappers around the model objects, the eclipse UML2 objects are passed directly into the templates as the model.

    The UML2 API is documented here:

    http://download.eclipse.org/modeling/mdt/uml2/javadoc/5.0.0/

    The generator documentation has been updated to reflect this.

     

Log in to post a comment.