Document! X 2017
ParameterDetail Metadata Element
Description
Outputs a formatted list of parameters for a particular item.
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
includeLetParameterbooleanSet to True to include a parameter for the property type (when documenting property parameters).
indexerbooleanSet to True if generating parameter detail for an indexer property.
langlangThe language for which the parameters should be formatted.
nobracketsbooleanSet to True to prevent surrounding brackets from being output around the parameter detail.
nocrbooleanSet to True to prevent carriage returns from being added to the generated output.
scraptextThe List Scrap name to use for formatting the parameter list.
Remarks
For members other than indexer properties, the Scraps {Language}_PARAMETERS_HEADER, {Language}_PARAMETERS_FOOTER and {Language}_PARAMETERS_BODY are used to format the output. For indexer properties, the Scraps {Language}_INDEXER_HEADER, {Language}_INDEXER_FOOTER and {Language}_INDEXER_FOOTER_INDEXER_BODY are used. If there are no parameters, the {Language}_EMPTY_PARAMETERS Scrap is used.

 

 

© 2018 Innovasys. All Rights Reserved.

Send comments on this topic.