Bugzilla – Full Text Bug Listing
| Summary: | Documentation on Element properties is not supported | ||
|---|---|---|---|
| Product: | z_Archived | Reporter: | Shenxue Zhou <shenxue.zhou> |
| Component: | Sapphire | Assignee: | Konstantin Komissarchik <konstantin> |
| Status: | CLOSED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | ||
| Version: | unspecified | ||
| Target Milestone: | --- | ||
| Hardware: | All | ||
| OS: | All | ||
| Whiteboard: | |||
> either implied element property or explicit element property
I will only use this to track fixing the lack of documentation hookup on regular ElementProperty. The ImpliedElementProperty has no UI manifestation. As such, there is nothing to attach its documentation content to.
Note that if the issue is too much granularity to document at property level, @Documentation can also be specified for the model element level. The content from property and the content from element are merged and then presented to the user.
Fixed. I have added @Documentation content to Assistant and PrimaryOccupation properties in the contacts sample to make verification easier. Please verify. Make sure to verify checkbox, radio button and combo box variants of element property presentation. I've verified the documentation support on regular element properties. Combining the documentation on element properties with the documentation on the element seems confusing in my use case. Documentation on my element property(using IMethodCallOutcome based "Outcome" property as an example) is specific about what kind of "outcome" it supports. Now the documentation on the "method call" element is appended in the end and it appears to be another case for the "outcome". It's rather confusing. Since element documentation isn't appended to other types of properties(value properties, list properties), we shouldn't append it to Element Properties either. > Since element documentation isn't appended to other types of properties
> (value properties, list properties), we shouldn't append it to Element
> Properties either.
This is done for all properties, not just element properties as it usually provides more context. This is new behavior for 0.4 release unrelated to this bug fix. You should be able to edit the content of your documentation contributions such that the confusion you describe is eliminated. If you need help with a particular case, talk to me about this on Oracle channels.
Verified the fix. Closing. |
@Documentation on Element property (either implied element property or explicit element property) is not supported. Documentation has to be done on child properties. For element properties with branches like the following: @Type ( base = IMethodCallOutcome.class, possible = { IFixedOutcome.class, IToStringOutcome.class } ) Documentation on the element property might be more appropriate since developers can document each branch to give customers an overview on all the options. Another issue is some branches may not contain child properties so it's hard to figure out a place for documentation on those branches. This is also not consistent with List properties in which documentation is done on List properties rather than on list elements.