Root / Assembly / ARCCore / Class / ITypeDescriber / _Member / GetSyntaxHelp

ClassMemberAttribute

GetSyntaxHelp

KeyValue
DescriptionEnables explanation of syntax in different contexts from one source:

The actual syntax information is placed in a SyntaxHelp member like SyntaxHelp

The syntax can then be published through different contexts like:

1) In ordinary documentation as created by ARCDoc
(this method is not involved)

2) In run time error messages given to for instance API clients.
(involving this method)

For variant 2) this method is typically called from a property method like SyntaxHelp. This method (GetSyntaxHelp) will return the Description of that member's -ClassAttribute.

Returns an empty string if no information found.
MethodNameGetSyntaxHelp
MethodSignatureSystem.String GetSyntaxHelp(System.Type, System.String)
ReflectedTypeARCCore.ITypeDescriber

4 items


Generated 2020-10-13 11:11:04.413 UTC