DocComment Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| DocComment(IEnumerable<String>) |
Constructs a DocComment instance from the documentation comments associated with a source code element. |
| DocComment(IEnumerable<String>, String, Boolean, String) |
Initializes a new instance of the DocComment class from the documentation comments associated with a source code element. |
DocComment(IEnumerable<String>)
Constructs a DocComment instance from the documentation comments associated with a source code element.
public DocComment (System.Collections.Generic.IEnumerable<string> docComments);new Microsoft.Quantum.QsCompiler.Documentation.DocComment : seq<string> -> Microsoft.Quantum.QsCompiler.Documentation.DocCommentPublic Sub New (docComments As IEnumerable(Of String))Parameters
- docComments
- IEnumerable<String>
The doc comments from the source code
Applies to
DocComment(IEnumerable<String>, String, Boolean, String)
Initializes a new instance of the DocComment class from the documentation comments associated with a source code element.
public DocComment (System.Collections.Generic.IEnumerable<string> docComments, string name, bool deprecated, string? replacement);new Microsoft.Quantum.QsCompiler.Documentation.DocComment : seq<string> * string * bool * string -> Microsoft.Quantum.QsCompiler.Documentation.DocCommentPublic Sub New (docComments As IEnumerable(Of String), name As String, deprecated As Boolean, replacement As String)Parameters
- docComments
- IEnumerable<String>
The doc comments from the source code
- name
- String
The name of the element
- deprecated
- Boolean
Flag indicating whether or not the element had a Deprecated attribute
- replacement
- String
The name of the replacement element for deprecated elements, if given