From 3cc5a02dd6083288890ff6745fa21472ecf0118f Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Mon, 5 Sep 2016 07:28:25 +0100 Subject: [PATCH] JavadocType: require @author tag in format "name (email)" --- README.md | 4 +--- src/main/resources/net/kemitix/checkstyle.xml | 4 +++- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3a9db02..ad9ac56 100644 --- a/README.md +++ b/README.md @@ -1245,9 +1245,7 @@ Checks the formatting of the Javadoc blocks. See the official [Checkstyle docume #### [JavadocType](http://checkstyle.sourceforge.net/config_javadoc.html#JavadocType) -Checks the format for Javadoc for classes and enums. Javadoc must be present, not have any unknown tags and not missing any `@param` tags. - -> TODO: authorFormat = "^.+ (\S+@[\S.]+)$" - name followed by email in brackets +Checks the format for Javadoc for classes and enums. Javadoc must be present, not have any unknown tags and not missing any `@param` tags. The `@author` tag must have a name and, in brackets, an email address. #### [JavaNCSS](http://checkstyle.sourceforge.net/config_metrics.html#JavaNCSS) diff --git a/src/main/resources/net/kemitix/checkstyle.xml b/src/main/resources/net/kemitix/checkstyle.xml index 33329a8..0ccd9a9 100644 --- a/src/main/resources/net/kemitix/checkstyle.xml +++ b/src/main/resources/net/kemitix/checkstyle.xml @@ -104,7 +104,9 @@ - + + +