Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Modeling » Papyrus » Documenting UML elements in Papyrus(There's no way to document a class, an operation etc.)
Documenting UML elements in Papyrus [message #695908] Tue, 12 July 2011 15:53 Go to next message
Jay Billings is currently offline Jay Billings
Messages: 43
Registered: July 2011
Member
I was working with Papyrus in Helios the other day and I could not find a way to document a UML element. So, for example, if you click on a class in a diagram, all sorts of properties are displayed, but there is no where that I could type a description of that class. Another pertinent example would be an operation on a class - what if I want to add some documentation to just that operation and not the rest of the class?

Am I missing something critical here?

I could accomplish this using a note, but the result is a diagram full of notes and I can't access the documentation in a transformation to code.


Jay Jay Billings
Oak Ridge National Laboratory
Twitter: @jayjaybillings
Re: Documenting UML elements in Papyrus [message #696084 is a reply to message #695908] Wed, 13 July 2011 04:35 Go to previous messageGo to next message
Vincent   is currently offline Vincent
Messages: 35
Registered: December 2009
Member
Or you could ... use the "Documentation" view.

This view isn't in the default perspective, so you must add it with "Window>Show View" menu.

Use the "Comments" tab to add or display a UML Comment.
After that, you can still grab and drop the Comment if you want to display it in the diagram, but I must confess I couldn't find a way to graphically link it to the label.
Re: Documenting UML elements in Papyrus [message #696144 is a reply to message #696084] Wed, 13 July 2011 07:04 Go to previous messageGo to next message
Jay Billings is currently offline Jay Billings
Messages: 43
Registered: July 2011
Member
Thanks Vincent. I will take a look at the documentation view.

Jay Jay Billings
Oak Ridge National Laboratory
Twitter: @jayjaybillings
Re: Documenting UML elements in Papyrus [message #946859 is a reply to message #696084] Tue, 16 October 2012 11:13 Go to previous messageGo to next message
Keith Dorking is currently offline Keith Dorking
Messages: 12
Registered: October 2012
Junior Member
In the latest version of Papyrus v0.9.1 is the Documentation view still available?
Re: Documenting UML elements in Papyrus [message #946955 is a reply to message #946859] Tue, 16 October 2012 13:15 Go to previous messageGo to next message
Christian W. Damus is currently offline Christian W. Damus
Messages: 779
Registered: July 2009
Senior Member
Hi, Keith,

It should be. Do you not see it in the Show View dialog?

Cheers,

Christian


On 2012-10-16 15:23:29 +0000, Keith Dorking said:

> In the latest version of Papyrus v0.9.1 is the Documentation view still
> available?
Re: Documenting UML elements in Papyrus [message #947773 is a reply to message #946955] Wed, 17 October 2012 08:20 Go to previous messageGo to next message
Keith Dorking is currently offline Keith Dorking
Messages: 12
Registered: October 2012
Junior Member
Hi Christian,

No unfortunately I do not see "Documentation" in the Show View dialog.. I have uploaded a screen capture of what I do see in the Show View dialog.

Cheers,
Keith




Re: Documenting UML elements in Papyrus [message #947980 is a reply to message #947773] Wed, 17 October 2012 12:29 Go to previous messageGo to next message
Christian W. Damus is currently offline Christian W. Damus
Messages: 779
Registered: July 2009
Senior Member
Hi, Keith,

This is the Show View menu, not the dialog.

What do you see when you choose the "Other..." option to open the Show
View dialog?

If you don't see the Documentation view in there, then you might check
the workspace log for any messages indicating that there's something
wrong with that view contribution, or that the plug-in that contributes
it has unresolved dependencies, or something.

HTH,

Christian


On 2012-10-17 12:20:29 +0000, Keith Dorking said:

> Hi Christian,
>
> No unfortunately I do not see "Documentation" in the Show View dialog..
> I have uploaded a screen capture of what I do see in the Show View
> dialog.
>
> Cheers,
> Keith
>
>
>
>
>
> <image>
Re: Documenting UML elements in Papyrus [message #948214 is a reply to message #947980] Wed, 17 October 2012 17:38 Go to previous messageGo to next message
Keith Dorking is currently offline Keith Dorking
Messages: 12
Registered: October 2012
Junior Member
Hi Christian,

Turns out that the Documentation view does not appear when Papyrus is installed with eclipse 4.2 (Juno), but it is there when Papyrus is installed with eclipse 3.7 (Indigo).



Thanks,
Keith

[Updated on: Wed, 17 October 2012 19:18]

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #997326 is a reply to message #948214] Sat, 05 January 2013 18:32 Go to previous messageGo to next message
Alexandre Kozlov is currently offline Alexandre Kozlov
Messages: 1
Registered: January 2013
Junior Member
It seems that the the following plugins are missing from the 0.9x

org.eclipse.papyrus.documentation.uml
org.eclipse.papyrus.documentation.view.papyrus
org.eclipse.papyrus.documentation.view
org.eclipse.papyrus.documentation

Re: Documenting UML elements in Papyrus [message #1006828 is a reply to message #997326] Sat, 02 February 2013 09:32 Go to previous messageGo to next message
alex lauter is currently offline alex lauter
Messages: 15
Registered: July 2009
Junior Member
Alexandre Kozlov wrote on Sat, 05 January 2013 18:32
It seems that the the following plugins are missing from the 0.9x

org.eclipse.papyrus.documentation.uml
org.eclipse.papyrus.documentation.view.papyrus
org.eclipse.papyrus.documentation.view
org.eclipse.papyrus.documentation



Where do I get the above files?
Re: Documenting UML elements in Papyrus [message #1007056 is a reply to message #1006828] Mon, 04 February 2013 04:28 Go to previous messageGo to next message
Camille Letavernier is currently offline Camille Letavernier
Messages: 444
Registered: February 2011
Senior Member
Quote:
Where do I get the above files?


The only way is to manually checkout the sources from the Papyrus SVN repository. These plug-ins are not shipped with Papyrus anymore. They should be replaced with a newer version in Papyrus 0.10/Kepler (June 2013).

SVN repository: http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/branches/0.9.X


Camille Letavernier
Papyrus developer
Re: Documenting UML elements in Papyrus [message #1063117 is a reply to message #1007056] Wed, 12 June 2013 07:49 Go to previous messageGo to next message
Keith Dorking is currently offline Keith Dorking
Messages: 12
Registered: October 2012
Junior Member
Is it still the intention to provide new documentation plugins as part of Papyrus release for Kepler?
Re: Documenting UML elements in Papyrus [message #1063120 is a reply to message #1063117] Wed, 12 June 2013 07:56 Go to previous messageGo to next message
Camille Letavernier is currently offline Camille Letavernier
Messages: 444
Registered: February 2011
Senior Member
Hi,


Yes. You should have a look here:

Bug 399858: [Documentation] Papyrus shall have an embedded documentation
https://bugs.eclipse.org/bugs/show_bug.cgi?id=399858

and its subtasks


Regards,


Camille Letavernier
Papyrus developer
Re: Documenting UML elements in Papyrus [message #1063128 is a reply to message #1063120] Wed, 12 June 2013 08:38 Go to previous messageGo to next message
Keith Dorking is currently offline Keith Dorking
Messages: 12
Registered: October 2012
Junior Member
Hi,

Bug 399858 and associated bugs seem to address the issue of making user and UML documentation available within Papyrus, which would be very useful.

My question was referring to the ability to document UML elements (through the documentation view). This capability was in the Indigo release, but was not part of the Juno release.

Apologies for not being clear or if I have misunderstood the fix for bug 399858.

Thanks.

Re: Documenting UML elements in Papyrus [message #1063131 is a reply to message #1063128] Wed, 12 June 2013 08:47 Go to previous messageGo to next message
Camille Letavernier is currently offline Camille Letavernier
Messages: 444
Registered: February 2011
Senior Member
Hi,

The documentation view won't be part of the Kepler release. We may still be able to reintroduce it for SR1, but that's not on our top-priority list.


Camille


Camille Letavernier
Papyrus developer
Re: Documenting UML elements in Papyrus [message #1073505 is a reply to message #1063131] Wed, 24 July 2013 20:06 Go to previous messageGo to next message
Keith Dorking is currently offline Keith Dorking
Messages: 12
Registered: October 2012
Junior Member
Hi,

I have built the plugins for the documentation view namely:

org.eclipse.papyrus.uml.documentation
org.eclipse.papyrus.documentation.view.papyrus
org.eclipse.papyrus.documentation.view
org.eclipse.papyrus.documentation

Using the source code from the master branch of org.eclipse.papyrus.git repository.

When I test the plugins using the "Launch an Eclipse application" everything appears to work fine, that is I see the Documentation view under Papyrus in the Show View window when and it appears to work as expected. However when I launch Eclipse from the command line the Documentation view is no longer shown.

Does anyone know what is happening?

Thanks,
Keith
Re: Documenting UML elements in Papyrus [message #1073819 is a reply to message #1073505] Thu, 25 July 2013 10:45 Go to previous messageGo to next message
Klaas Gadeyne is currently offline Klaas Gadeyne
Messages: 86
Registered: July 2009
Member
Did you install the plugins into your 'host'?

http://help.eclipse.org/kepler/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Ftasks%2Fui_export_install_into_host.htm
Re: Documenting UML elements in Papyrus [message #1073930 is a reply to message #1073819] Thu, 25 July 2013 15:30 Go to previous message
Keith Dorking is currently offline Keith Dorking
Messages: 12
Registered: October 2012
Junior Member
Yes I did. I installed them in the dropins directory.

Keith
Previous Topic:Message Argument Vs Signal Attribute ?
Next Topic:How to add a Node in the Nodes field?
Goto Forum:
  


Current Time: Tue Sep 02 13:03:58 EDT 2014

Powered by FUDForum. Page generated in 0.03327 seconds