Custom attribute used for documentation More...

Inheritance diagram for QuantConnect.DocumentationAttribute:

Public Member Functions
	DocumentationAttribute (string tag, int weight=0, [System.Runtime.CompilerServices.CallerLineNumber] int line=0, [System.Runtime.CompilerServices.CallerFilePath] string fileName="")
	Creates a new instance More...

Public Attributes
override object	TypeId => base.TypeId
	The attributes type id, we override it to ignore it when serializing More...

Properties
string	Tag `[get]`
	The documentation tag More...

int	Weight `[get]`
	The associated weight of this attribute and tag More...

int	Line `[get]`
	The associated line of this attribute More...

string	FileName `[get]`
	The associated file name of this attribute More...

Detailed Description

Custom attribute used for documentation

Definition at line 28 of file DocumentationAttribute.cs.

Constructor & Destructor Documentation

◆ DocumentationAttribute()

QuantConnect.DocumentationAttribute.DocumentationAttribute	(	string	tag,
		int	weight = `0`,
		[System.Runtime.CompilerServices.CallerLineNumber] int	line = `0`,
		[System.Runtime.CompilerServices.CallerFilePath] string	fileName = `""`
	)

Creates a new instance

Definition at line 68 of file DocumentationAttribute.cs.

Member Data Documentation

◆ TypeId

override object QuantConnect.DocumentationAttribute.TypeId => base.TypeId

The attributes type id, we override it to ignore it when serializing

Definition at line 63 of file DocumentationAttribute.cs.

Property Documentation

◆ Tag

string QuantConnect.DocumentationAttribute.Tag

get

The documentation tag

Definition at line 39 of file DocumentationAttribute.cs.

◆ Weight

int QuantConnect.DocumentationAttribute.Weight

get

The associated weight of this attribute and tag

Definition at line 45 of file DocumentationAttribute.cs.

◆ Line

int QuantConnect.DocumentationAttribute.Line

get

The associated line of this attribute

Definition at line 51 of file DocumentationAttribute.cs.

◆ FileName

string QuantConnect.DocumentationAttribute.FileName

get

The associated file name of this attribute

Definition at line 57 of file DocumentationAttribute.cs.

The documentation for this class was generated from the following file:

Common/DocumentationAttribute.cs

Public Member Functions

Public Attributes

Properties