diff options
Diffstat (limited to 'clang-tools-extra/clang-tidy/readability/FunctionSizeCheck.h')
| -rw-r--r-- | clang-tools-extra/clang-tidy/readability/FunctionSizeCheck.h | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/clang-tools-extra/clang-tidy/readability/FunctionSizeCheck.h b/clang-tools-extra/clang-tidy/readability/FunctionSizeCheck.h index 819f04d07b1..1231cb139ea 100644 --- a/clang-tools-extra/clang-tidy/readability/FunctionSizeCheck.h +++ b/clang-tools-extra/clang-tidy/readability/FunctionSizeCheck.h @@ -16,7 +16,17 @@ namespace clang { namespace tidy { namespace readability { -/// \brief Checks for large functions based on various metrics. +/// Checks for large functions based on various metrics. +/// +/// These options are supported: +/// +/// * `LineThreshold` - flag functions exceeding this number of lines. The +/// default is `-1` (ignore the number of lines). +/// * `StatementThreshold` - flag functions exceeding this number of +/// statements. This may differ significantly from the number of lines for +/// macro-heavy code. The default is `800`. +/// * `BranchThreshold` - flag functions exceeding this number of control +/// statements. The default is `-1` (ignore the number of branches). class FunctionSizeCheck : public ClangTidyCheck { public: FunctionSizeCheck(StringRef Name, ClangTidyContext *Context); |

