ApiParameter
Pennington.ApiMetadata
One parameter of a method or constructor, formatted for display.
Properties
DescriptionImmutableArray<XmlDocNode>- Parsed xmldoc nodes from the matching
<param>element. Namestring- Parameter name as declared.
TypeDisplaystring- Fully-formatted type display including ref/out/in prefixes and optional markers.
Constructors
ApiParameter
#public ApiParameter(string Name, string TypeDisplay, ImmutableArray<XmlDocNode> Description)
One parameter of a method or constructor, formatted for display.
Parameters
Namestring- Parameter name as declared.
TypeDisplaystring- Fully-formatted type display including ref/out/in prefixes and optional markers.
DescriptionImmutableArray<XmlDocNode>- Parsed xmldoc nodes from the matching
<param>element.
Pennington.ApiMetadata.ApiParameter
namespace Pennington.ApiMetadata;
/// One parameter of a method or constructor, formatted for display.
public record ApiParameter
{
/// One parameter of a method or constructor, formatted for display.
public ApiParameter(string Name, string TypeDisplay, ImmutableArray<XmlDocNode> Description)
;
/// Parsed xmldoc nodes from the matching <param> element.
public ImmutableArray<XmlDocNode> Description { get; set; }
/// Parameter name as declared.
public string Name { get; set; }
/// Fully-formatted type display including ref/out/in prefixes and optional markers.
public string TypeDisplay { get; set; }
}