Module Documentation

Import path

Documentation.Documentation

Imports

csharp

The default C# QL library.

Predicates

declarationHasXmlComment

Whether the declaration has a documentation comment.

getADeclarationCommentBlock

Gets a comment block bound to this declaration.

getADeclarationXmlComment

Gets an XML comment bound to this declaration.

isDocumentationNeeded

Whether a declaration should have documentation.

Classes

ExceptionXmlComment

An XML comment containing an <exception> tag.

InheritDocXmlComment

An XML comment containing an <inheritdoc> tag.

ParamXmlComment

An XML comment containing a <param> tag.

ReturnsXmlComment

An XML comment containing a <returns> tag.

SourceConstructor

A constructor that is in the source code and not compiler-generated.

SourceDeclaration
SourceMethod

A method that has come from source code.

SourceMethodOrConstructor

A method or constructor from source code.

SourceParameter

A parameter that has come from source code.

SummaryXmlComment

An XML comment containing a <summary> tag.

TypeparamXmlComment

An XML comment containing a <typeparam> tag.