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;
enum string MISSING_THROW_KEY;
enum string MISSING_THROW_MESSAGE;
}

Constructors

this
this(string fileName, bool skipTests = false)

Inherited Members

From BaseAnalyzer

visit
void visit(const Unittest unittest_)

Visits a unittest.

fileName
string fileName;

The file name

Meta