Home » Modeling » EMF » How to control default javadoc creation..(Switching off default Javadoc content..)
| | |
Re: How to control default javadoc creation.. [message #1020413 is a reply to message #1020241] |
Mon, 18 March 2013 05:38 |
Ed Merks Messages: 33217 Registered: July 2009 |
Senior Member |
|
|
Kapil,
Comments below.
On 17/03/2013 6:30 PM, Kapil Gambhir wrote:
> Ed, appreciate a prompt response.
> Yes i tried the approach that u mentioned and this way the custom doc
> content (i.e. value of key "documentation"), mentioned in the ecore is
> generated inside <!-- begin-model-doc --> ..<!-- end-model-doc --> and
> the earlier one is not emitted.
Exactly.
> The challenge i have is that the number of these instances is quite
> high (and thus not efficient to be done manually).
No, though it's only a few lines of code to read and Ecore resource, and
use Resource.getAllContents to visit each EStructuralFeature and use
EcoreUtil.setDocumentation("").
> I guess the intent of this default value is to ensure owners provide
> something meaningful,
Yes.
> but am wondering if its a good idea to provide a ecore directive to
> switch it off, which is also an indication that the owner of the model
> owns what comes out.
I suppose so. Yet more options...
> As a side note, if i want to hide the documentation for certain
> elements or attributes, would the ecore:ignore of the
> xsd:documentation help.
Yes or on the xsd:annotation itself.
Ed Merks
Professional Support: https://www.macromodeling.com/
|
|
|
Re: How to control default javadoc creation.. [message #1020568 is a reply to message #1020413] |
Mon, 18 March 2013 13:32 |
|
Hi, Ed, Kapil,
Is this bit of the Javadoc overrideable in custom templates? If not,
factoring it out into a *.javajetinc could be a lighter-weight solution
than adding an option to the GenModel.
cW
On 2013-03-18 05:38:10 +0000, Ed Merks said:
> Kapil,
>
> Comments below.
>
>
> On 17/03/2013 6:30 PM, Kapil Gambhir wrote:
>> Ed, appreciate a prompt response.
>> Yes i tried the approach that u mentioned and this way the custom doc
>> content (i.e. value of key "documentation"), mentioned in the ecore is
>> generated inside <!-- begin-model-doc --> ..<!-- end-model-doc --> and
>> the earlier one is not emitted.
> Exactly.
>> The challenge i have is that the number of these instances is quite
>> high (and thus not efficient to be done manually).
> No, though it's only a few lines of code to read and Ecore resource,
> and use Resource.getAllContents to visit each EStructuralFeature and
> use EcoreUtil.setDocumentation("").
>> I guess the intent of this default value is to ensure owners provide
>> something meaningful,
> Yes.
>> but am wondering if its a good idea to provide a ecore directive to
>> switch it off, which is also an indication that the owner of the model
>> owns what comes out.
> I suppose so. Yet more options...
>> As a side note, if i want to hide the documentation for certain
>> elements or attributes, would the ecore:ignore of the xsd:documentation
>> help.
> Yes or on the xsd:annotation itself.
|
|
|
Re: How to control default javadoc creation.. [message #1020571 is a reply to message #1020568] |
Mon, 18 March 2013 13:39 |
Ed Merks Messages: 33217 Registered: July 2009 |
Senior Member |
|
|
Christian,
There's only //Class/getGenFeature.javadoc.override.javajetinc that
affects the entire Javadoc comment, not just this part.
On 18/03/2013 2:32 PM, Christian W. Damus wrote:
> Hi, Ed, Kapil,
>
> Is this bit of the Javadoc overrideable in custom templates? If not,
> factoring it out into a *.javajetinc could be a lighter-weight
> solution than adding an option to the GenModel.
>
> cW
>
>
> On 2013-03-18 05:38:10 +0000, Ed Merks said:
>
>> Kapil,
>>
>> Comments below.
>>
>>
>> On 17/03/2013 6:30 PM, Kapil Gambhir wrote:
>>> Ed, appreciate a prompt response.
>>> Yes i tried the approach that u mentioned and this way the custom
>>> doc content (i.e. value of key "documentation"), mentioned in the
>>> ecore is generated inside <!-- begin-model-doc --> ..<!--
>>> end-model-doc --> and the earlier one is not emitted.
>> Exactly.
>>> The challenge i have is that the number of these instances is quite
>>> high (and thus not efficient to be done manually).
>> No, though it's only a few lines of code to read and Ecore resource,
>> and use Resource.getAllContents to visit each EStructuralFeature and
>> use EcoreUtil.setDocumentation("").
>>> I guess the intent of this default value is to ensure owners provide
>>> something meaningful,
>> Yes.
>>> but am wondering if its a good idea to provide a ecore directive to
>>> switch it off, which is also an indication that the owner of the
>>> model owns what comes out.
>> I suppose so. Yet more options...
>>> As a side note, if i want to hide the documentation for certain
>>> elements or attributes, would the ecore:ignore of the
>>> xsd:documentation help.
>> Yes or on the xsd:annotation itself.
>
>
Ed Merks
Professional Support: https://www.macromodeling.com/
|
|
|
Goto Forum:
Current Time: Mon Sep 23 07:25:36 GMT 2024
Powered by FUDForum. Page generated in 0.04904 seconds
|