Document! X and HelpStudio 2017
In This Topic
    ParameterSummary Metadata Element
    In This Topic
    Description
    Outputs a one line summary of an items parameters, formatted using the specified language.
    Usage

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

    • Method
    • Property
    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
    languageNametextThe language for which the parameters should be formatted.
    noBracketsbooleanSet to True to prevent surrounding brackets from being output around the parameter detail.
    Remarks
    Uses the Scraps {Language}_PARAMETERS_SUMMARY_HEADER,{Language}_PARAMETERS_SUMMARY_FOOTER,{Language}_PARAMETERS_SUMMARY_BODY to format the output if parameters exist. If there are no parameters, the {Language}_EMPTY_PARAMETERS Scrap is used for output.

     

     

    © 2018 Innovasys. All Rights Reserved.

    Send comments on this topic.