This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy at the same URL with .md appended. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Skip to main content Skip to navigation

ApiParameter Pennington.ApiMetadata

One parameter of a method or constructor, formatted for display.

Properties

Description ImmutableArray<XmlDocNode>
Parsed xmldoc nodes from the matching <param> element.
Name string
Parameter name as declared.
TypeDisplay string
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

Name string
Parameter name as declared.
TypeDisplay string
Fully-formatted type display including ref/out/in prefixes and optional markers.
Description ImmutableArray<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; }
}