Eclipse Community Forums: Papyrus » Documenting UML elements in Papyrus

Search

Help

Login

Home » Modeling » Papyrus » Documenting UML elements in Papyrus(There's no way to document a class, an operation etc.)

Show: Today's Messages :: Show Polls :: Message Navigator

Switch to threaded view of this topic

Create a new topic

Submit Reply

Documenting UML elements in Papyrus [message #695908]

Tue, 12 July 2011 19:53

Jay Billings is currently offline

Friend

Messages: 54
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

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #696084 is a reply to message #695908]

Wed, 13 July 2011 08:35

Vincent is currently offline

Friend

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.

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #696144 is a reply to message #696084]

Wed, 13 July 2011 11:04

Jay Billings is currently offline

Friend

Messages: 54
Registered: July 2011

Member

Thanks Vincent. I will take a look at the documentation view.

Jay Jay Billings
Oak Ridge National Laboratory
Twitter: @jayjaybillings

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #946859 is a reply to message #696084]

Tue, 16 October 2012 15:13

Keith Dorking is currently offline

Friend

Messages: 12
Registered: October 2012

Junior Member

In the latest version of Papyrus v0.9.1 is the Documentation view still available?

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #946955 is a reply to message #946859]

Tue, 16 October 2012 17:15

Christian Damus is currently offline

Christian Damus

Friend

Messages: 1270
Registered: July 2009
Location: Canada

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?

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #947773 is a reply to message #946955]

Wed, 17 October 2012 12:20

Keith Dorking is currently offline

Friend

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

Attachment: Papyrus_Show_View.jpg
(Size: 71.03KB, Downloaded 284 times)

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #947980 is a reply to message #947773]

Wed, 17 October 2012 16:29

Christian Damus is currently offline

Christian Damus

Friend

Messages: 1270
Registered: July 2009
Location: Canada

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>

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #948214 is a reply to message #947980]

Wed, 17 October 2012 21:38

Keith Dorking is currently offline

Friend

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 23:18]

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #997326 is a reply to message #948214]

Sat, 05 January 2013 23:32

Alexandre Kozlov is currently offline

Alexandre Kozlov

Friend

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

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1006828 is a reply to message #997326]

Sat, 02 February 2013 14:32

alex lauter is currently offline

Friend

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?

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1007056 is a reply to message #1006828]

Mon, 04 February 2013 09:28

Camille Letavernier is currently offline

Camille Letavernier

Friend

Messages: 952
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

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1063117 is a reply to message #1007056]

Wed, 12 June 2013 11:49

Keith Dorking is currently offline

Friend

Messages: 12
Registered: October 2012

Junior Member

Is it still the intention to provide new documentation plugins as part of Papyrus release for Kepler?

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1063120 is a reply to message #1063117]

Wed, 12 June 2013 11:56

Camille Letavernier is currently offline

Camille Letavernier

Friend

Messages: 952
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

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1063128 is a reply to message #1063120]

Wed, 12 June 2013 12:38

Keith Dorking is currently offline

Friend

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.

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1063131 is a reply to message #1063128]

Wed, 12 June 2013 12:47

Camille Letavernier is currently offline

Camille Letavernier

Friend

Messages: 952
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

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1073505 is a reply to message #1063131]

Thu, 25 July 2013 00:06

Keith Dorking is currently offline

Friend

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

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1073819 is a reply to message #1073505]

Thu, 25 July 2013 14:45

Klaas Gadeyne is currently offline

Friend

Messages: 165
Registered: July 2009

Senior 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

Report message to a moderator

Re: Documenting UML elements in Papyrus [message #1073930 is a reply to message #1073819]

Thu, 25 July 2013 19:30

Keith Dorking is currently offline

Friend

Messages: 12
Registered: October 2012

Junior Member

Yes I did. I installed them in the dropins directory.

Keith

Report message to a moderator

Switch to threaded view of this topic

Create a new topic

Submit Reply

Previous Topic:	Message Argument Vs Signal Attribute ?
Next Topic:	The interpretation of action Execution Specification in Papyrus

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Fri Apr 19 22:15:04 GMT 2024

Powered by FUDForum. Page generated in 0.03926 seconds

.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top