Changes to bring in new options and to support GenModel and generics amont other #6
Conversation
forced to import UI plugins.
launch document generation
documented all options that can be passed in new option file.
document from the GenModel and not only from the Ecore. Includes options to produce subtypes, use generics, full latex document, etc.
abelhegedus
left a comment
abelhegedus
left a comment
There was a problem hiding this comment.
First of all, thanks for the contribution, it looks great overall!
While I have not yet tried it in action, I read through all the changes.
My only question is regarding the commons.io dependency:
Did you use the Maven build to check that your changes do not break it?
It seems to me that the library should come from Orbit (e.g. http://download.eclipse.org/tools/orbit/downloads/drops/R20160520211859/ contains 2.2.0).
We can fix up the build independently from this change, but I am interested in how you built the application yourself.
| </classpath> | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <classpath> | ||
| <classpathentry exported="true" kind="lib" path="lib/org.apache.commons.io_2.2.0.v201405211200.jar"/> |
There was a problem hiding this comment.
Why is this needed? It refers to a nonexistent file and is missing from the target platform as far as I can see.
| Bundle-RequiredExecutionEnvironment: JavaSE-1.6 | ||
| Bundle-RequiredExecutionEnvironment: JavaSE-1.8 | ||
| Export-Package: hu.qgears.gendoc.app | ||
| Bundle-ClassPath: lib/org.apache.commons.io_2.2.0.v201405211200.jar, |
There was a problem hiding this comment.
This also refers to a non-existent file.
|
This was not used and the dependency left behind which I have now removed. |
|
Great, I checked locally and only found problems in the hu.qgears.xtextdoc plugin that I can easily fix. /plugins/hu.qgears.xtextdoc/src/hu/qgears/xtextdoc/generator/GrammarSingleFileHTML.java
- h.documentEPackage(sb, p, Collections.<String>emptyList(), false);
+ h.generateDocument(sb, p, ImmutableList.of(CoreDocGen.SKIP_HEADER), null);Thanks for your contribution! I will merge it soon unless you have anything you want to add. |
2 participants
Guys,
This is the result of the changes. As you will notice it supports a number of options in the docgen to provide finer control on the output. Also it allows processing the Genmodel and understand generic (if option is turned on). That being said I am aware that the logic to provide generics could be improved but it is usable at this point.
Our goal was to stay as close as possible as the original unless options are changed. Also now both the Latex and Html output logic is driven by a common class, that should facilitate future enhancements.
I am by no means an expert with Latex, but I ran a number of tests with our internal models and it looks quite good to me.
Please feel free to ask any questions and to provide any feedback to you see fit.
Alain