Document! X and HelpStudio 2019
In This Topic
    Syntax Metadata Element
    In This Topic
    Description
    Outputs a syntax block 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
    • Interface
    • Structure
    • Enumeration
    • Constructor
    • Method
    • Property
    • Field
    • Event
    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
    includeprefixbooleanSet to True in order to include the language prefix (if any).
    langlangThe language to return syntax for.
    Remarks
    Depending on the item type, one of the following Scraps will be used to format the output: _{Language}_CLASS_SYNTAX, _{Language}_INTERFACE_SYNTAX, _{Language}_STRUCTURE_SYNTAX, _{Language}_ENUMERATION_SYNTAX, _{Language}_DELEGATE_SYNTAX, _{Language}_CONSTRUCTOR_SYNTAX, _{Language}_METHOD_SYNTAX, _{Language}_PROPERTY_SYNTAX, _{Language}_FIELD_SYNTAX, _{Language}_EVENT_SYNTAX, _{Language}_OPERATOR_SYNTAX

     

     

    © 2019 Innovasys. All Rights Reserved.

    Send comments on this topic.