This site provides a machine-readable index at /llms.txt.

Skip to main content Skip to navigation

ApiParameter Pennington.ApiMetadata

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

Properties

Description System.Collections.Immutable.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

.ctor

#
public sealed record 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 sealed record ApiParameter(
    string Name,
    string TypeDisplay,
    ImmutableArray<XmlDocNode> Description);


    /// Parsed xmldoc nodes from the matching <param> element.
    
ImmutableArray<XmlDocNode> Description
;

    /// Parameter name as declared.
    
string Name
;

    /// Fully-formatted type display including ref/out/in prefixes and optional markers.
    
string TypeDisplay
;
}