This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 225520 - No way to document operation return code/object
Summary: No way to document operation return code/object
Status: RESOLVED WONTFIX
Alias: None
Product: Tigerstripe (Archived)
Classification: Technology
Component: Core (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: 0.3S4   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 220345
Blocks:
  Show dependency tree
 
Reported: 2008-04-03 06:22 EDT by Yoram CLA
Modified: 2010-12-06 14:52 EST (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Yoram CLA 2008-04-03 06:22:29 EDT
Build ID: M20071023-1652

Steps To Reproduce:
1. Define an opefrational interface and a method in it
2. Define a return value for that method
3. Try to add some description for that return value


More information:
One can pick a type for the return value and assign a name to it. However, no way to add description. So, if I define a return value of type 'int' and name it referenceCount, I also want to write a little piece of text that says "The number of references to the object in the system" -- I have to put this in the documentation for the method but this is inconvenient at times
Comment 1 Eric Dillon CLA 2008-04-03 10:51:21 EDT
Indeed, this is currently not handled by our Metamodel, so we don't really have a way to capture it.
That being said we are in the process of revisiting that metamodel as part of the EMF migration so it should be added there first. I'm marking this bug as dependent on 220345 and added a note there too.
Comment 2 Navid Mehregani CLA 2010-12-06 14:52:00 EST
Marking as WONTFIX.  Description about the method, return value, arguments, stereotypes, and exceptions should all be specified in one place (i.e. under method description).  There is no need to provide a separate description text box for each component of a method.