Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [sapphire-dev] Documentation on Element property

Yes, this should be supported. Please open a bug for the 0.4 release.

- Konstantin


-----Original Message-----
From: sapphire-dev-bounces@xxxxxxxxxxx
[mailto:sapphire-dev-bounces@xxxxxxxxxxx] On Behalf Of Shenxue Zhou
Sent: Tuesday, October 11, 2011 8:51 AM
To: Sapphire project
Subject: [sapphire-dev] Documentation on Element property

It seems that @Documentation on Element property (either implied element
property or explicit element property) is not supported. Documentation has
to be done on child properties. For element properties with branches like
the following:
 
    @Type
    ( 
        base = IMethodCallOutcome.class, 
        possible = 
        { 
            IFixedOutcome.class, 
            IToStringOutcome.class
        }
    )

Documentation on the element property might be more appropiate since
developers can document each branch to give customers an overview on all the
options. Another issue is some branches may not contain child properties so
it's hard to figure out a place for documentation on those branches.

Another issue is this is not consistent with List properties in which
documentation has to be done on List properties rather than on list
elements. 

Thoughts?

Thanks,

Shenxue
_______________________________________________
sapphire-dev mailing list
sapphire-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/sapphire-dev



Back to the top