UndocumentedDeclarationCheck

Checks for undocumented public declarations. Ignores some operator overloads, main functions, and functions whose name starts with "get" or "set".

class UndocumentedDeclarationCheck : BaseAnalyzer {

alias visit = BaseAnalyzer.visit;

this(string fileName, const(Scope)* sc, bool skipTests);

void visit(Module mod);

void visit(Declaration dec);

void visit(VariableDeclaration variable);

void visit(ConditionalDeclaration cond);

void visit(FunctionBody fb);

void visit(Unittest u);

void visit(TraitsExpression t);

mixin V!AnonymousEnumMember ;

mixin V!ClassDeclaration ;

mixin V!EnumDeclaration ;

mixin V!InterfaceDeclaration ;

mixin V!StructDeclaration ;

mixin V!UnionDeclaration ;

mixin V!TemplateDeclaration ;

mixin V!FunctionDeclaration ;

mixin V!Constructor ;

}

Constructors

this this(string fileName, const(Scope)* sc, bool skipTests): Undocumented in source.

Members

Aliases

visit alias visit = BaseAnalyzer.visit: Undocumented in source.

Functions

visit void visit(Module mod): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(Declaration dec): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(VariableDeclaration variable): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(ConditionalDeclaration cond): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(FunctionBody fb): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(Unittest u): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(TraitsExpression t): Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous mixin V!AnonymousEnumMember: Undocumented in source.
__anonymous mixin V!ClassDeclaration: Undocumented in source.
__anonymous mixin V!EnumDeclaration: Undocumented in source.
__anonymous mixin V!InterfaceDeclaration: Undocumented in source.
__anonymous mixin V!StructDeclaration: Undocumented in source.
__anonymous mixin V!UnionDeclaration: Undocumented in source.
__anonymous mixin V!TemplateDeclaration: Undocumented in source.
__anonymous mixin V!FunctionDeclaration: Undocumented in source.
__anonymous mixin V!Constructor: Undocumented in source.

Inherited Members

From BaseAnalyzer

messages Message[] messages(): Undocumented in source. Be warned that the author may not have intended to support it.
visit alias visit = ASTVisitor.visit: Undocumented in source.
visit void visit(Unittest unittest_): Visits a unittest.
inAggregate bool inAggregate;: Undocumented in source.
skipTests bool skipTests;: Undocumented in source.
visitTemplate template visitTemplate(T): Undocumented in source.
addErrorMessage void addErrorMessage(size_t line, size_t column, string key, string message): Undocumented in source. Be warned that the author may not have intended to support it.
fileName string fileName;: The file name
sc const(Scope)* sc;: Undocumented in source.
_messages MessageSet _messages;: Undocumented in source.

Meta

Source

See Implementation

analysis undocumented classes

UndocumentedDeclarationCheck