ProperlyDocumentedPublicFunctions

Requires each public function to contain the following ddoc sections - PARAMS: - if the function has at least one parameter - every parameter must have a ddoc params entry (applies for template paramters too) - Ddoc params entries without a parameter trigger warnings as well - RETURNS: (except if it's void, only functions)

class ProperlyDocumentedPublicFunctions : BaseAnalyzer {

enum string MISSING_PARAMS_KEY;

enum string MISSING_PARAMS_MESSAGE;

enum string MISSING_TEMPLATE_PARAMS_MESSAGE;

enum string NON_EXISTENT_PARAMS_KEY;

enum string NON_EXISTENT_PARAMS_MESSAGE;

enum string MISSING_RETURNS_KEY;

enum string MISSING_RETURNS_MESSAGE;

this(string fileName, bool skipTests);

void visit(Module mod);

void visit(Declaration decl);

void visit(TemplateDeclaration decl);

void visit(MixinTemplateDeclaration decl);

void visit(StructDeclaration decl);

void visit(ClassDeclaration decl);

void visit(FunctionDeclaration decl);

alias visit = BaseAnalyzer.visit;

}

Constructors

this this(string fileName, bool skipTests)

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 decl): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(TemplateDeclaration decl): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(MixinTemplateDeclaration decl): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(ClassDeclaration decl): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(StructDeclaration decl): Undocumented in source. Be warned that the author may not have intended to support it.
visit void visit(FunctionDeclaration decl): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

MISSING_PARAMS_KEY enum string MISSING_PARAMS_KEY;: Undocumented in source.
MISSING_PARAMS_MESSAGE enum string MISSING_PARAMS_MESSAGE;: Undocumented in source.
MISSING_RETURNS_KEY enum string MISSING_RETURNS_KEY;: Undocumented in source.
MISSING_RETURNS_MESSAGE enum string MISSING_RETURNS_MESSAGE;: Undocumented in source.
MISSING_TEMPLATE_PARAMS_MESSAGE enum string MISSING_TEMPLATE_PARAMS_MESSAGE;: Undocumented in source.
NON_EXISTENT_PARAMS_KEY enum string NON_EXISTENT_PARAMS_KEY;: Undocumented in source.
NON_EXISTENT_PARAMS_MESSAGE enum string NON_EXISTENT_PARAMS_MESSAGE;: 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.