Table of contents
TOC
Collapse the table of content
Expand the table of content

CompilerServices.TypeProviderXmlDocAttribute Class (F#)

Den Delimarsky|Last Updated: 8/18/2017
|
1 Contributor

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)

Syntax

[<AttributeUsage(32767, AllowMultiple = false)>]
type [TypeProviderXmlDocAttribute](https://msdn.microsoft.com/library/15df1059-16f1-4855-ab6a-860d60003c90) =
class
new TypeProviderXmlDocAttribute : string -> TypeProviderXmlDocAttribute
member this.CommentText : string
end

Remarks

You can also use the short form of the name, TypeProviderXmlDoc.

Constructors

MemberDescription
newCreates an instance of the attribute.

Instance Members

MemberDescription
CommentTextThe 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

See Also

Microsoft.FSharp.Core.CompilerServices Namespace (F#)

© 2017 Microsoft