Eclipse Community Forums: Oomph » Oomph Setup SDK Documentation Incomplete

Help

Home

Home » Eclipse Projects » Oomph » Oomph Setup SDK Documentation Incomplete

Show: Today's Messages :: Show Polls :: Message Navigator

Oomph Setup SDK Documentation Incomplete [message #1774180]

Wed, 11 October 2017 10:57

Adrian Price

Messages: 8
Registered: October 2017

Junior Member

I have the Oomph Setup SDK 1.9.0.v20170706-0615 installed in Eclipse Oxygen, wherein 'Help > Help Contents > [toc] > Oomph Setup Documentation > Reference > API Reference' lists 14 'Oomp Xxx' topics for various org.eclipse.oomph.setup.* EMF packages.

However, I could not find any such API References for the org.eclipse.oomph.resources or org.eclipse.oomph.predicates packages (note: there may be other packages missing that I haven't noticed yet).

Also, the generated Javadocs are the bare minimum produced automatically by EMF Codegen; there don't seem to be any GenModel/documentation annotations in the Ooomph Ecore models, so the resulting Javadocs do not describe the semantics and usage of the various generated types. This makes it hard to understand how to author a setup model. I appreciate that the docs & Wiki have some 'cookbook'-style examples but that is no substitute for rigorous, complete API documentation. All in all I'm finding this quite a steep learning curve, which is a shame since Oomph is clearly a powerful and well-engineered installer.

Report message to a moderator

Re: Oomph Setup SDK Documentation Incomplete [message #1774201 is a reply to message #1774180]

Wed, 11 October 2017 15:37

Ed Merks

Messages: 33141
Registered: July 2009

Senior Member

Yes, writing complete documentation is a huge amount of work, and is not nearly as interesting as implementing all the cool features. :-( I expect authoring documentation would be more useful than documentation the Java APIs....

Ed Merks
Professional Support: https://www.macromodeling.com/

Report message to a moderator

Re: Oomph Setup SDK Documentation Incomplete [message #1774205 is a reply to message #1774201]

Wed, 11 October 2017 16:51

Adrian Price

Messages: 8
Registered: October 2017

Junior Member

Thanks Ed, I know all about writing boring documentation and I do understand how developer time tends to get prioritised. ;-)

But did you note the comment about the EMF packages whose API Reference is missing from the SDK docs?

Report message to a moderator