aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java
diff options
context:
space:
mode:
authorGravatar fzaiser <fzaiser@google.com>2017-09-14 11:24:46 +0200
committerGravatar Philipp Wollermann <philwo@google.com>2017-09-14 18:47:51 +0200
commit2000a0446cdd3f438b788752725f500ce157eb9e (patch)
tree4c67f979256b0e637fe6a9e3c05eeb86ab1d5655 /src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java
parent213a52a29ac445781f0cd55d1909eecce0f29fd5 (diff)
Skylint: report missing documentation for a function's return value
In addition to checking the function parameter documentation, skylint now also checks whether the return value is documented in a 'Returns:' section in the docstring. The same restrictions as for parameters apply: - Private functions need no documentation - If a function has a single line docstring, it need not document the return value. In addition, I improved the docstring parsing: - Previously, the beginning and end of a section (e.g. 'Args:', 'Returns:') were determined by line breaks. Now, they're determined by indentation and missing line breaks are reported. This change should make the docstring parser more robust. - Additional indentation is not warned against anymore. There are many situations where it makes sense, like example code. Both of these changes were motivated by the results of the linter on Skylark files "in the wild". RELNOTES: none PiperOrigin-RevId: 168660248
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/rules/cpp/CppCompileAction.java')
0 files changed, 0 insertions, 0 deletions