From 43e37136e1c31da381739a55254fc2d4bb5ef102 Mon Sep 17 00:00:00 2001 From: Glenn Adams Date: Tue, 6 Mar 2012 00:07:13 +0000 Subject: update convention documentation regarding @author usage git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1297305 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/dev/conventions.xml | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'src/documentation/content') diff --git a/src/documentation/content/xdocs/dev/conventions.xml b/src/documentation/content/xdocs/dev/conventions.xml index e68c11a5e..4fd949fdd 100644 --- a/src/documentation/content/xdocs/dev/conventions.xml +++ b/src/documentation/content/xdocs/dev/conventions.xml @@ -102,12 +102,10 @@ In general, other languages must not be used, except in translated documentation checkstyle - Personal attribution in the source code, such as @author tags and attribution comments should not be used. -Excepted from this general rule are potentially confusing or wide-ranging changes. -If such changes prove useful over time, the related comments should be removed. - Personal attribution tends to clutter the code. -The relevant historical information that might be useful for problem-solving is tracked in the code repository. - Not enforced. Anyone is free to remove such comments. + By ASF policy, @author tags are officially discouraged. +However it is permissible to indicate the original author(s) of an entire file or package in a comment provided it follows the copyright and license header. + Attribution of subsequent contributions are recorded by the SVN commit history logs, so should not be included. + checkstyle

For developers that dislike these conventions, one workaround is to develop using their own style, then use a formatting tool like astyle (Artistic Style) before committing.

-- cgit v1.2.3