CompilerServices.TypeProviderXmlDocAttribute Class (F#)
The TypeProviderXmlDocAttribute attribute can be added to types and members. The language service will display the CommentText property from the attribute in the appropriate place when the user performs either of the following steps:
Points to a type or member in the Visual Studio editor.
Moves the cursor so that it appears next to or within the name of a type or member and then chooses the Ctrl+K, I keys.
Namespace/Module Path: Microsoft.FSharp.Core.CompilerServices
Assembly: FSharp.Core (in FSharp.Core.dll)
[<AttributeUsage(32767, AllowMultiple = false)>]
type TypeProviderXmlDocAttribute =
class
new TypeProviderXmlDocAttribute : string -> TypeProviderXmlDocAttribute
member this.CommentText : string
end
Remarks
You can also use the short form of the name, TypeProviderXmlDoc.
Constructors
Member |
Description |
---|---|
Creates an instance of the attribute. |
Instance Members
Member |
Description |
---|---|
The text that describes the generated type or member. |
Platforms
Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2
Version Information
F# Core Library Versions
Supported in: 4.0, Portable