Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 350339

Summary:

Type documentation can be presented in confusing manner

Product:

z_Archived

Reporter:

Konstantin Komissarchik <konstantin>

Component:

Sapphire

Assignee:

Konstantin Komissarchik <konstantin>

Status:

CLOSED FIXED

QA Contact:

Severity:

normal

Priority:

CC:

ling.hao

Version:

unspecified

Target Milestone:

---

Hardware:

All

OS:

All

Whiteboard:

Attachments:

Description	Flags
Example of the problem	none

Description Konstantin Komissarchik

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

2011-06-24 20:17:32 EDT

Created attachment 198592 [details]
Example of the problem

Comment 2 Konstantin Komissarchik

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

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.