DocComment Class

Definition

Namespace:

Microsoft.Quantum.QsCompiler.Documentation

Assembly:

Microsoft.Quantum.QsDocumentationParser.dll

Package:

Microsoft.Quantum.Compiler v0.25.218240

This class represents the parsed documentation comments for a Q# item (operation, function, type, etc.).

public class DocComment

type DocComment = class

Public Class DocComment

Inheritance

Object

DocComment

Constructors

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.

Properties

Description	The (rest of the) full description of the item. This should not duplicate the summary, but rather follow it.
Documentation	The full markdown-formatted on-line documentation for the item. Currently this consists of the summary field followed by the description field.
Example	Obsolete. All examples of using the named item, concatenated as a single Markdown document.
Examples	A list of examples of using the item.
FullSummary	The full markdown-formatted hover information for the item. Currently this is the same as the short hover.
Input	The inputs to the item, as a list of symbol/description pairs. This is only populated for functions and operations.
NamedItems	Descriptions of each named item for the item being documented, as a dictionary from identifiers for each named item to the corresponding description.
Output	The output from the item. This is only populated for functions and operations.
References	Reference material about the item.
Remarks	Additional commentary about the item.
SeeAlso	A list of links to other documentation related to this item.
ShortSummary	The short hover information for the item. This should be one paragraph of plain text. Currently this is the first paragraph of the summary field.
Summary	The summary description of the item. This should be one paragraph of plain text.
TypeParameters	The type parameters for the item, as a list of symbol/description pairs. This is only populated for functions and operations.