Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Papyrus/Oxygen Work Description/NewFeature/DocumentationView"

(Created page with "Papyrus will provide a Documentation view similar to the one from Topcased File:DocumentationView.png")
 
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
Papyrus will provide a Documentation view similar to the one from Topcased
+
=== Papyrus will provide a Documentation view similar to the one from Topcased ===
  
 
[[File:DocumentationView.png]]
 
[[File:DocumentationView.png]]
 +
 +
=== Technical Information ===
 +
The documentation view will display the "Documentation" attached to a model element.
 +
When the comment does not already exist, the editor should be empty but modifiable. In this case, when the text has to be saved (by losing the focus as in the property view or with a “commit” button), the "Documentation" comment will be created on the fly.
 +
 +
The "Documentation" element will be customizable by strategy, there will be 2 strategies provided by the core
 +
*First Uml Comment attached to the element
 +
*The attached comment stereotyped by <<Documentation>>
 +
 +
[[File:DocumentationViewPreferences.jpg]]
 +
 +
=== Related Tasks ===
 +
[https://bugs.eclipse.org/bugs/show_bug.cgi?id=501511 Bug 501511] - [Documentation] A new documentation View for UML Element shall be available.

Latest revision as of 10:02, 16 February 2017

Papyrus will provide a Documentation view similar to the one from Topcased

DocumentationView.png

Technical Information

The documentation view will display the "Documentation" attached to a model element. When the comment does not already exist, the editor should be empty but modifiable. In this case, when the text has to be saved (by losing the focus as in the property view or with a “commit” button), the "Documentation" comment will be created on the fly.

The "Documentation" element will be customizable by strategy, there will be 2 strategies provided by the core

  • First Uml Comment attached to the element
  • The attached comment stereotyped by <<Documentation>>

DocumentationViewPreferences.jpg

Related Tasks

Bug 501511 - [Documentation] A new documentation View for UML Element shall be available.

Back to the top