Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 350339 - Type documentation can be presented in confusing manner
Summary: Type documentation can be presented in confusing manner
Status: CLOSED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Sapphire (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Konstantin Komissarchik CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-06-24 20:16 EDT by Konstantin Komissarchik CLA
Modified: 2021-11-19 09:22 EST (History)
1 user (show)

See Also:


Attachments
Example of the problem (38.11 KB, image/png)
2011-06-24 20:17 EDT, Konstantin Komissarchik CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Konstantin Komissarchik CLA 2011-06-24 20:16:42 EDT
In certain cases, it doesn't make sense to specify documentation at property or you end up with unuseful documentation entries like "name of x" or "description of x". To support those cases, we allow documentation to be specified at type level. The intention is that type documentation is appended to property documentation. This works ok when property has documentation, but when property has no documentation, the documentation of the title (property label) does not appear to correspond to the content. 

If type documentation exists, but property documentation does not exists, we should use type label as opposed to property label for documentation title.
Comment 1 Konstantin Komissarchik CLA 2011-06-24 20:17:32 EDT
Created attachment 198592 [details]
Example of the problem
Comment 2 Konstantin Komissarchik CLA 2011-07-01 17:07:09 EDT
Implemented the following semantics:

if( property documentation or property facts exist )
{
    set context help title to property label
    include property documentation and facts
    
    if( type documentation exists )
    {
        append type documentation in a separate section with type
        label as the section title
    }
}
else
{
    if( type documentation exists )
    {
        set context help title to type label
        include type documentation
    }
}

Ling, please verify.
Comment 3 Ling Hao CLA 2011-11-28 17:49:25 EST
Verify with sapphire-gallery extended help.

Just noting that the separate section has a different font/color as the main section. But I don't think there is anytime we can do due to limitation of the help UI.