Document! X 2017
In This Topic
    Keyword Metadata Element
    In This Topic
    Description
    Outputs a language keyword for a particular item.
    Usage

    This Metadata Element can only be used in Page Types or Scraps that relate to the Javascript Library Documentation Item Types listed below. (more info)

    • Class
    • Structure
    • Interface
    • Enumeration
    • Method
    • Constructor
    • Property
    • Field
    • Event
    • Parameter
    Use in Page Types or scraps that do not relate to these specific Item Types may result in unexpected output or documentation build errors.
    Parameters
    ParameterTypeDescription
    langlangThe language for which the keyword should be returned (e.g. "cs", "vb").
    nospacebooleanSet to True to prevent a space from being output before the keyword.
    propertylist 

    One of the following values:

    AbstractFor overloadable members only. Returns the language specific keyword that indicates a member is abstract (e.g. abstract in csharp).
    ArrayFor Parameter only. Returns the language specific text that indicates an array (e.g. [] in csharp).
    IsByRefFor Parameter only. Returns the language specific keyword that indicates a parameter is passed by reference (e.g. ref in csharp).
    IsOptionalFor Parameter only. Returns the language specific keyword that indicates a Parameter Array parameter.
    IsOutFor Parameter only. Returns the language specific keyword that indicates a parameter is marked as an out parameter (e.g. out in csharp).
    MustInheritFor types, returns the language specific keyword that indicates a type is abstract (e.g. abstract in csharp).
    NotInheritableFor types, returns the language specific keyword that indicates a type cannot be inherited (e.g. sealed in csharp).
    NotVirtualFor overloadable members only. Returns the language specific keword that indicates a member is not overridable (e.g. sealed in csharp).
    OverloadsFor overloadable members only. Returns the language specific keyword that indicates a member is an overload (e.g. overloads in csharp).
    OverridesFor overloadable members only. Returns the language specific keyword that indicates a member overrides a base implementation (e.g. overrides in csharp).
    ParamArrayFor Parameter only. Returns the language specific keyword that indicates a Parameter Array parameter (e.g. ParamArrary in Visual Basic).
    ShadowsFor members. Returns the language specific keyword that indicates a member shadows a base member (e.g. new in csharp).
    StaticFor members and types. Returns the language specific keyword that indicates a member is static (e.g. static in csharp).
    StaticClassFor types, returns the language specific keyword that indicates a type is static (e.g. static in csharp).
    VirtualFor overloadable members only. Returns the language specific keyword that indicates a member is virtual (e.g. virtual in csharp).
    Remarks
    Keywords are only returned when they are applicable to the item. i.e. the OVERLOADS keyword would only return a value if the item is actually an overload.

     

     

    © 2018 Innovasys. All Rights Reserved.

    Send comments on this topic.