This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 306093 - Allow for description or contextual help annotations
Summary: Allow for description or contextual help annotations
Status: CLOSED FIXED
Alias: None
Product: Tigerstripe (Archived)
Classification: Technology
Component: Annotations (show other bugs)
Version: 0.5   Edit
Hardware: PC Mac OS X - Carbon (unsup.)
: P3 enhancement (vote)
Target Milestone: 0.5M0   Edit
Assignee: Eric Dillon CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-03-16 17:48 EDT by Eric Dillon CLA
Modified: 2012-02-14 12:11 EST (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Eric Dillon CLA 2010-03-16 17:48:45 EDT 
When a lot of annotations are defined, and they are used in complex scenario, it would be good to present users with a description of how the annotation is to be used and why, in other words some contextual help on a given annotation.
This could be a popup with some formated content.
Comment 1 Yuri Strot CLA 2010-05-26 05:33:48 EDT 
Hi Eric,

I think it's a good idea. Probably we can use something similar to eclipse context help. So when user add annotation through New Annotation Wizard he/she can click to context help (?) and see detailed description with some examples. Another way may be to show simple tooltip when user hover on an annotation and by F2 (like in Java Editor) show our detailed help. What do you think about it?
Comment 2 Navid Mehregani CLA 2012-02-14 12:11:42 EST 
This is already supported.  Annotation descriptions are displayed in annotation wizard dialog.  Developers can also associate a description to annotation parameters.