forks
/
D-Scanner
mirror of https://github.com/dlang-community/D-Scanner.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #606 from wilzbach/fix-601 

Fix #601 - dscanner should not complain about Params section when there's no ddoc
merged-on-behalf-of: BBasile <BBasile@users.noreply.github.com>
This commit is contained in:
The Dlang Bot 2018-04-06 13:38:47 +02:00 committed by GitHub
parent c048dfd1f3 9aec2bc485
commit 586a7ab262
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
src/dscanner/analysis/properly_documented_public_functions.d
View File

@ -72,12 +72,13 @@ class ProperlyDocumentedPublicFunctions : BaseAnalyzer
if (islastSeenVisibilityLabelPublic || decl.attributes.map!`a.attribute`.any!(x => x == tokPublic)) if (islastSeenVisibilityLabelPublic || decl.attributes.map!`a.attribute`.any!(x => x == tokPublic))
{ {
if (decl.functionDeclaration !is null || // Don't complain about non-documented function declarations
decl.templateDeclaration !is null || if ((decl.functionDeclaration !is null && decl.functionDeclaration.comment.ptr !is null) ||
(decl.templateDeclaration !is null && decl.templateDeclaration.comment.ptr !is null) ||
decl.mixinTemplateDeclaration !is null || decl.mixinTemplateDeclaration !is null ||
decl.classDeclaration !is null || (decl.classDeclaration !is null && decl.classDeclaration.comment.ptr !is null) ||
decl.structDeclaration !is null) (decl.structDeclaration !is null && decl.structDeclaration.comment.ptr !is null))
decl.accept(this); decl.accept(this);
} }
} }
@ -112,7 +113,7 @@ class ProperlyDocumentedPublicFunctions : BaseAnalyzer
override void visit(const FunctionDeclaration decl) override void visit(const FunctionDeclaration decl)
{ {
import std.algorithm.searching : any; import std.algorithm.searching : all, any;
// ignore header declaration for now // ignore header declaration for now
if (decl.functionBody is null) if (decl.functionBody is null)
@ -453,8 +454,10 @@ unittest
Some text Some text
*/ */
private void foo(int k){} private void foo(int k){}
///
public int bar(){} // [warn]: %s public int bar(){} // [warn]: %s
public: public:
///
int foobar(){} // [warn]: %s int foobar(){} // [warn]: %s
}c.format( }c.format(
ProperlyDocumentedPublicFunctions.MISSING_RETURNS_MESSAGE, ProperlyDocumentedPublicFunctions.MISSING_RETURNS_MESSAGE,
@ -468,8 +471,10 @@ unittest
Some text Some text
*/ */
private template foo(int k){} private template foo(int k){}
///
public template bar(T){} // [warn]: %s public template bar(T){} // [warn]: %s
public: public:
///
template foobar(T){} // [warn]: %s template foobar(T){} // [warn]: %s
}c.format( }c.format(
ProperlyDocumentedPublicFunctions.MISSING_TEMPLATE_PARAMS_MESSAGE.format("T"), ProperlyDocumentedPublicFunctions.MISSING_TEMPLATE_PARAMS_MESSAGE.format("T"),
@ -483,8 +488,10 @@ unittest
Some text Some text
*/ */
private struct foo(int k){} private struct foo(int k){}
///
public struct bar(T){} // [warn]: %s public struct bar(T){} // [warn]: %s
public: public:
///
struct foobar(T){} // [warn]: %s struct foobar(T){} // [warn]: %s
}c.format( }c.format(
ProperlyDocumentedPublicFunctions.MISSING_TEMPLATE_PARAMS_MESSAGE.format("T"), ProperlyDocumentedPublicFunctions.MISSING_TEMPLATE_PARAMS_MESSAGE.format("T"),
@ -761,9 +768,10 @@ unittest
* Returns: bar * Returns: bar
*/ */
template abcde(Args ...) { template abcde(Args ...) {
auto abcde(T, U...)(T t, U varargs) { ///
/// .... auto abcde(T, U...)(T t, U varargs) {
} /// ....
}
} }
}c, sac); }c, sac);
} }
@ -801,6 +809,21 @@ string bar(P, R)(R r){}// [warn]: %s
), sac); ), sac);
} }
// https://github.com/dlang-community/D-Scanner/issues/601
unittest
{
StaticAnalysisConfig sac = disabledConfig;
sac.properly_documented_public_functions = Check.enabled;
assertAnalyzerWarnings(q{
void put(Range)(Range items) if (canPutConstRange!Range)
{
alias p = put!(Unqual!Range);
p(items);
}
}, sac);
}
// https://github.com/dlang-community/D-Scanner/issues/583 // https://github.com/dlang-community/D-Scanner/issues/583
unittest unittest
{ {