| Documentation generation based on grammar [message #1820910] |
Fri, 31 January 2020 12:52  |
 Rob K
Messages: 5
Registered: January 2020 |
Junior Member |
|
|
Hi,
I'm trying to generate documentation based on my .Xtext grammar. My example Types.xtext file, located in types/src, has the following line:
Range:
min = (NUMER|DECIMAL) ',' max = (NUMBER|DECIMAL)
This generates the Range.java file in types/src-gen. This contains among others the method & generated documentation:
/**
* Returns the value of the '<em><b>Min</b></em>' attribute
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Min</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
... {some parts skipped} ...
*/
String getMin();
The default user-doc text implies that you can add some documentation, however since Range.java is entirely generated based on the xtext file editing it would be pointless. I have tried several ways of adding documentation to the xtext file (using the '//' and '/**' annotation methods) but none of these results in the generated files getting documentation.
Is there an official way to generate user doc based on documentation int he xtext file, and if yes, how?
Thanks for your time
[Updated on: Wed, 05 February 2020 06:43] Report message to a moderator |
|
|
|
|
|
|
|
Powered by
FUDForum. Page generated in 0.02034 seconds
] 
Search
Help
Register
Login
Home
