ApiDocAttribute (FSharp.Formatting)

ApiDocAttribute Type

Namespace: FSharp.Formatting.ApiDocs
Assembly: FSharp.Formatting.ApiDocs.dll
Base Type: obj

Represents a custom attribute attached to source code

Constructors

Constructor Description

Constructor	Description
`ApiDocAttribute(name, fullName, constructorArguments, namedConstructorArguments)` Full Usage: `ApiDocAttribute(name, fullName, constructorArguments, namedConstructorArguments)` Parameters: name : `string` fullName : `string` constructorArguments : `obj list` namedConstructorArguments : `(string * obj) list` Returns: `ApiDocAttribute`	name : `string` fullName : `string` constructorArguments : `obj list` namedConstructorArguments : `(string * obj) list` Returns: `ApiDocAttribute`


                
                  
                    
                      ApiDocAttribute(name, fullName, constructorArguments, namedConstructorArguments)

Full Usage: ApiDocAttribute(name, fullName, constructorArguments, namedConstructorArguments)

Parameters:

name : string

fullName : string

constructorArguments : obj list

namedConstructorArguments : (string * obj) list

Returns: ApiDocAttribute

name : string
fullName : string
constructorArguments : obj list
namedConstructorArguments : (string * obj) list

Returns: ApiDocAttribute

Instance members

Instance member	Description
`this.ConstructorArguments` Full Usage: `this.ConstructorArguments` Returns: `obj list`	The arguments to the constructor for the attribute Returns: `obj list`
`this.CustomOperationName` Full Usage: `this.CustomOperationName` Returns: `string`	Returns the custom operation name, when this attribute is the CustomOperationAttribute. When its not an empty string is returned Returns: `string`
`this.Format` Full Usage: `this.Format` Returns: `string`	Formats the attribute using the Name. Removes the "Attribute"-suffix. E.g Obsolete Returns: `string`
`this.FormatFullName` Full Usage: `this.FormatFullName` Returns: `string`	Formats the attribute using the FullName. Removes the "Attribute"-suffix. E.g System.Obsolete Returns: `string`
`this.FormatFullNameLongForm` Full Usage: `this.FormatFullNameLongForm` Returns: `string`	Formats the attribute using the FullName. Keeps the "Attribute"-suffix. E.g System.ObsoleteAttribute Returns: `string`
`this.FormatLongForm` Full Usage: `this.FormatLongForm` Returns: `string`	Formats the attribute using the Name. Keeps the "Attribute"-suffix. E.g ObsoleteAttribute Returns: `string`
`this.FullName` Full Usage: `this.FullName` Returns: `string`	The qualified name of the attribute Returns: `string`
`this.IsCustomOperationAttribute` Full Usage: `this.IsCustomOperationAttribute` Returns: `bool`	Gets a value indicating whether this attribute the CustomOperationAttribute Returns: `bool`
`this.IsObsoleteAttribute` Full Usage: `this.IsObsoleteAttribute` Returns: `bool`	Gets a value indicating whether this attribute is System.ObsoleteAttribute Returns: `bool`
`this.IsRequireQualifiedAccessAttribute` Full Usage: `this.IsRequireQualifiedAccessAttribute` Returns: `bool`	Gets a value indicating whether this attribute is RequireQualifiedAccessAttribute Returns: `bool`
`this.Name` Full Usage: `this.Name` Returns: `string`	The name of the attribute Returns: `string`
`this.NamedConstructorArguments` Full Usage: `this.NamedConstructorArguments` Returns: `(string * obj) list`	The named arguments for the attribute Returns: `(string * obj) list`
`this.ObsoleteMessage` Full Usage: `this.ObsoleteMessage` Returns: `string`	Returns the obsolete message, when this attribute is the System.ObsoleteAttribute. When its not or no message was specified, an empty string is returned Returns: `string`