-
Notifications
You must be signed in to change notification settings - Fork 2
XML Documentation Items JSON Format
The following formats are used in type, field, property, event, constructor, and method templates. These formats are the XML comment documentations found on the code that has been compiled into a separate .xml file, and imported into these formats.
- XML Documentation Items (XmlDocItems)
- NameDescription
- ParameterNameDescription
- GenericParameterNameDescription
- ExistsValue
- ExistsReturnsValue
- ExistsValueArray
- ExistsParameterValueArray
- ExistsGenericParameterValueArray
This format is the C#'s XML Comment Documentation in JSON form. This is applied to types and members of types (fields, properties, events, constructors, methods, and operators).
summary as (string): The summary of the type/member. Defaults to "No Description." if there is no summary written for the type/member.
returns as (ExistsReturnsValue): Gets the return value with details and whether it exists.
remarks as (ExistsValue): Gets the remarks value and whether it exists.
example as (ExistsValue): Gets the example value and whether it exists.
parameters as (ExistsParameterValueArray): Gets the list of parameters (names, descriptions, and details) and whether it exists.
exceptions as (ExistsValueArray): Gets the list of exceptions (names and descriptions) and whether it exists.
typeParameters as (ExistsGenericParameterValueArray): Gets the list of type parameters (names, descriptions, and details) and whether it exists.
This format contains a name and a description. Mainly used for mapping names of values to their documented description.
name as (string): The name of the content, typically a parameter.
description as (string): The description of the content, typically the description documented.
This format contains a name, description, and details of the parameter. Mainly used for mapping parameters' names to their documented description.
name as (string): The name of the content, typically a parameter.
description as (string): The description of the content, typically the description documented.
details as (ParameterInfo or undefined): The details of the parameter to give more in-depth information about the code.
This format contains a name, description, and details of the generic parameter. Mainly used for mapping generic parameters' names to their documented description.
name as (string): The name of the content, typically a parameter.
description as (string): The description of the content, typically the description documented.
details as (GenericParametersInfo or undefined): The details of the generic parameter to give more in-depth information about the code.
This format checks if there exists a value and the value itself, used to not render anything if there isn't a value.
exists as (boolean): Set to true if the value exists.
value as (string): The value as a string, if it exists. This is normally the description of the content.
This format checks if there exists a value, the value itself, and the return type information; used to not render anything if there isn't a value.
exists as (boolean): Set to true if the value and details exists.
value as (string): The value as a string, if it exists. This is normally the description of the content.
details as (QuickTypeInfo or undefined): The type information details that the return value holds.
This format checks if there exists an array of values and the array itself, used to not render anything if there isn't a value.
exists as (boolean): Set to true if the value exists.
value as (NameDescription[]): The array of values as names mapped to their descriptions, if it exists.
This format checks if there exists an array of values and the array itself, used to not render anything if there isn't a value and is used for parameters.
exists as (boolean): Set to true if the array of values exists.
value as (ParameterNameDescription[]): The list of names mapped to their description and the detail of the parameter, if it exists.
This format checks if there exists an array of values and the array itself, used to not render anything if there isn't a value and is used for generic parameters.
exists as (boolean): Set to true if the array of values exists.
value as (GenericParameterNameDescription[]): The list of names mapped to their description and the detail of the generic parameter, if it exists.