Class ParameterInfoAttribute
This attribute specifies a description and other metadata of a parameter. It can be applied to a field, property or method
Inherited Members
Namespace: SpiceSharp.Attributes
Assembly: SpiceSharp.dll
Syntax
[AttributeUsage(AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false, Inherited = false)]
public sealed class ParameterInfoAttribute : AttributeRemarks
If this attribute is used on a private field, the source generator will automatically generate a property.
Constructors
ParameterInfoAttribute(string)
Initializes a new instance of the ParameterInfoAttribute class.
Declaration
public ParameterInfoAttribute(string description)Parameters
| Type | Name | Description |
|---|---|---|
| string | description | The description of the parameter. |
Properties
Description
Gets the parameter description.
Declaration
public string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Interesting
Gets or sets whether or not this parameter is interesting. Defaults to true.
Declaration
public bool Interesting { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsPrincipal
Gets or sets whether or not this parameter is a principal design parameter. Defaults to false.
Declaration
public bool IsPrincipal { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Units
Gets or sets the units of the parameter.
Declaration
public string Units { get; set; }Property Value
| Type | Description |
|---|---|
| string | The units. |