Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 351617 - JavaDoc description for SortingStyle is inconsistent
Summary: JavaDoc description for SortingStyle is inconsistent
Status: CLOSED WONTFIX
Alias: None
Product: GMF-Runtime
Classification: Modeling
Component: Notation (show other bugs)
Version: 2.1   Edit
Hardware: All All
: P3 trivial
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact:
URL: http://publib.boulder.ibm.com/infocen...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-07-09 05:56 EDT by Ingo Budde CLA
Modified: 2023-02-05 11:15 EST (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ingo Budde CLA 2011-07-09 05:56:26 EDT
The JavaDoc for the "org.eclipse.gmf.runtime.notation.SortingStyle" interface seems to be inconsistent for the methods "getSortingKeys()" and "setSortingKeys()".

The description of getSortingKeys() states that the return value was a map of java.lang.String objects to "org.eclipse.gmf.runtime.notation.SortingDirection".

The description of setSortingKeys(Map) states that the value must be an empty map or one that contains only java.lang.String objects in the keys and "org.eclipse.gmf.runtime.notation.Alignment" objects in the values.

So of what type should the values in the map be:
1) org.eclipse.gmf.runtime.notation.SortingDirection, or
2) org.eclipse.gmf.runtime.notation.Alignment

I guess, it is 1).
Comment 1 Pierre-Charles David CLA 2022-12-28 10:04:44 EST
Eclipse GMF Notation is moving away from this bugs.eclipse.org issue tracker to
https://github.com/eclipse/gmf-notation.

If this issue is relevant to you and still present in the latest release:

* Create a new issue at https://github.com/eclipse/gmf-notation/issues/.
  * Use as title in GitHub the title of this Bugzilla ticket (may include the bug number or not, at your own convenience)
  * In the GitHub description, start with a link to this bugzilla ticket
  * Optionally add new content to the description if it can helps towards resolution
* Update bugzilla ticket
  * Add to "See also" property (up right column) the link to the newly created GitHub issue
  * Add a comment "Migrated to <link-to-newly-created-GitHub-issue>"
  * Set status as CLOSED MOVED

All issues that remain open will be automatically closed in the next few weeks. Then
the Bugzilla component for GMF Notation will be archived and made read-only.
Comment 2 Pierre-Charles David CLA 2023-02-05 11:15:29 EST
Closing as part of the move to GitHub.
Feel free to re-open an equivalent issue at https://github.com/eclipse/gmf-notation/issues if you feel this is still relevant.