eclipse-uml2 / uml2

An EMF-based implementation of the UML 2.x metamodel for the Eclipse platform.
Eclipse Public License 2.0
5 stars 4 forks source link

Improved Documentation #14

Open eclipse-uml2-bot opened 1 week ago

eclipse-uml2-bot commented 1 week ago

| --- | --- | | Bugzilla Link | 77413 | | Status | ASSIGNED | | Importance | P3 enhancement | | Reported | Nov 01, 2004 14:30 EDT | | Modified | Mar 29, 2013 09:34 EDT | | Version | 1.0.0 | | Depends on | 205478, 382342 | | Reporter | Kenn Hussey |

Description

Improve UML2 documentation by updating the FAQ, enhancing the Javadoc, and \ publishing new articles.

eclipse-uml2-bot commented 1 week ago

By Kenn Hussey on Nov 11, 2004 13:28

In particular, the Javadoc for Element#getValue(Stereotype, String) and \ Element#setValue(Stereotype, String, Object) needs to be enhanced to describe \ the use of "property expressions" to (recursively) get/set the values of \ attributes on (nested) complex types.

eclipse-uml2-bot commented 1 week ago

By Kenn Hussey on Jul 21, 2005 16:39

The FAQ and Javadoc (now available online for each UML2 release) were updated \ in UML2 1.1. Documentation will be further improved (e.g. existing articles \ will be updated and new articles will be added) during the 2.0 release cycle.

eclipse-uml2-bot commented 1 week ago

By Kenn Hussey on Apr 19, 2006 16:13

The fix has been committed to CVS.

eclipse-uml2-bot commented 1 week ago

By James Bruck on May 25, 2006 18:07

Created attachment 42660 migration doc

Migration document

:notepad_spiral: migrationDoc.patch

eclipse-uml2-bot commented 1 week ago

By James Bruck on May 31, 2006 10:43

Created attachment 43099 (attachment deleted)\ Migration doc update

Updated .html to work with Firefox

eclipse-uml2-bot commented 1 week ago

By James Bruck on May 31, 2006 10:45

Created attachment 43100 (attachment deleted)\ Zipped up images

zipped up version of migration doc so that binary images work.

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jun 13, 2006 14:15

Created attachment 44308 migration doc update format

:notepad_spiral: migrationDocUpdate.patch

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jun 13, 2006 14:25

Created attachment 44312 zipped up version of patch

:compression: migrationDoc.zip

eclipse-uml2-bot commented 1 week ago

By Kenn Hussey on Jun 20, 2006 14:31

Continued improvements to documentation will be made in a future release.

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jul 17, 2006 10:17

Created attachment 46371 added programatic migration

:notepad_spiral: migrationDocUpdate07172006.patch

eclipse-uml2-bot commented 1 week ago

By James Bruck on Dec 08, 2006 15:06

Planned items.

-Article on extending UML. (90% complete)\ -Article on creating heavy-weight extensions. (60% complete)\ -Update to migration document ( document profile application in migration ).

eclipse-uml2-bot commented 1 week ago

By James Bruck on Dec 08, 2006 15:18

Created attachment 55336 Extending UML doc

( almost complete ;) )

:compression: Extending_UML2.zip

eclipse-uml2-bot commented 1 week ago

By James Bruck on Dec 08, 2006 15:19

Created attachment 55337 Heavyweight extension

documentation started.

:compression: HeavyWeightExtension.zip

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jan 30, 2007 12:14

Created attachment 57812 describes the UML2.profile.uml profile.

MigrationProfile.doc

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jan 31, 2007 09:37

Created attachment 57911 (attachment deleted)\ mapping ecore generics to uml ( draft )

eclipse-uml2-bot commented 1 week ago

By Nicolas Rouquette on Feb 08, 2007 17:26

The UML2.1 superstructure spec (ptc/06-04-02) in 18.3.6 (Profile)\ shows an example of XMI for exchanging profiles (pages 694 to 696)\ that includes an XMI definition of the profile in XML schema.

For the lightweight profile customization strategy,\ what are the pros/cons of producing such XMI schema definitions?\ Specifically, can we use the XMI schema definition of a UML profile\ to simplify matters of UML interoperability along the lines\ of https://bugs.eclipse.org/bugs/show_bug.cgi?id=80306 ?

eclipse-uml2-bot commented 1 week ago

By JG on Mar 04, 2007 07:28

The Javadoc for the package org.eclipse.uml2.common is in dire need for more documentation, especially when it comes to the purposes of the different EList implementations provided there. This is critical, as they -- AFAIK -- still have to be used manually to implement derived associations in one's model.

eclipse-uml2-bot commented 1 week ago

By Yves YANG on Mar 04, 2007 15:08

Created attachment 60230 Tutorial to create Domain metamodel using the heavyextension

This is a tutorial of the domain metamodel creation. It uses a simplified BPMN model as example. In fact, it is a Proof of Concept to implement BPDM metamodel.

:compression: Applying UML Profile for Extended Metamode.zip

eclipse-uml2-bot commented 1 week ago

By James Bruck on Mar 16, 2007 17:25

Created attachment 61171 How to use composite structures

:compression: CompositeStructureExample.zip

eclipse-uml2-bot commented 1 week ago

By Nicolas Rouquette on Mar 16, 2007 20:56

James, the composite structure document is a good start; I would suggest clarifying your assumptions w.r.t. the notion of 'connector' you use.

Many ADLs distinguish make a distinction between modeling architecture element types and modeling instances of such types. For example, CMU's AcmeStudio calls the former an architecture "family" and the later an architecture "system". With the UML, we have a reasonable type/instance distinction for components and ports but things become muddled very quickly for connectors.

In the UML superstructure spec, a connector links instances of components in a specific context such as a collaboration. However, the decision to enforce a typing on what constitutes legal connections is left up to the user in the UML whereas in other ADLs, the user can express this typing constraint in the form of, e.g., a connector type in AcmeStudio.

In your document, there is some glimpse of this in several parts:

What if I want to say that the customer use port must be a structural feature of a component instance fulfilling the role of an administrator type and that the customer provided port must be a structural feature of a component instance fulfilling the role of a customer type? There are many ways to model this in the UML; one example is enough. The point here is that the instance-level topology of use/provided port connections should be type checkable.

Cheers,\ -- Nicolas.

eclipse-uml2-bot commented 1 week ago

By James Bruck on Mar 19, 2007 09:51

Nicholas,

Thanks for the feedback. I'll definitely take your comments into account before finishing this article (it's quite rough now). The idea behind this article comes from questions in the newsgroup about composite structures and the vague notion of "connector" and what exactly it means for two ports to be connected. Frankly, I have not seen any examples explaining this in great detail.

I also wanted to clarify that assembly connectors should not be shown on component diagrams. Context is required amongst other things.

I find it very intersting that the spec speaks of parts in terms of instances and does not mention parts in terms of the static nature of a system. Parts are afterall properties and properties can be considered to be part of the static nature of encapsulated classifiers in a similar way that attributes are part of the static definition of a class.\ The "instance" notion seems to be an implied runtime concept. Presumably your component will be part of a running system so the spec seems to skip to the instance terminology. I could say that at runtime, any general instance of this class will have these parts and these parts will be connected in this manner. I could speak about attributes of a class in a similar fashion but the spec doesn't. I can see the need to describe parts as instances when connectors come into play. Connectors really say that "somehow" these two parts are connected at runtime... but that connection is vague. The connection itself might only exist at runtime. It could be implented as a lookup table etc.

There also seems to be some overlapping terminology. For example, "Link" is an InstanceSpecification of type Attribute whereas we talk about Connectors as "links". Connectors seem to be a bit more vague than true Links. (Connectors may or may not be typed by Associations). Composite structures really talk about any general instance whereas object diagrams talk about specific instances. \ The reason for choosing the MFC type example is to explain all the gory details of hooking up process using ports.\ I will consider other examples. Also, I intend to finish the article by including every type of diagram in UML, including Object diagram.

Thanks again ... any other input is appreciated.

eclipse-uml2-bot commented 1 week ago

By Kenn Hussey on Apr 25, 2007 15:07

Javadoc has been added for parameters of custom and valdation operations.

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jun 28, 2007 15:27

Created attachment 72730 (attachment deleted)\ Migration from UML2 2.0 to UML2 2.1

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jul 11, 2007 15:28

Created attachment 73587 Migration from 2.0 to 2.1

:compression: UML20_UML21_Migration.zip

eclipse-uml2-bot commented 1 week ago

By James Bruck on Jul 27, 2007 17:14

Created attachment 74838 (attachment deleted)\ generics in UML (draft)

eclipse-uml2-bot commented 1 week ago

By James Bruck on Sep 18, 2007 09:22

Created attachment 78642 Generics with UML Templates

:compression: Defining_Generics_with_UML_Templates.zip