Kevin S. Clarke created MJAVADOC-396:
----------------------------------------

             Summary: @author tag added to header instead of above class 
declaration
                 Key: MJAVADOC-396
                 URL: https://jira.codehaus.org/browse/MJAVADOC-396
             Project: Maven Javadoc Plugin
          Issue Type: Bug
    Affects Versions: 2.9.1
         Environment: Linux ksclarke-laptop 3.13.0-18-generic #38-Ubuntu SMP 
Mon Mar 17 21:40:06 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux

java version "1.7.0_55"
OpenJDK Runtime Environment (IcedTea 2.4.7) (7u55-2.4.7-1ubuntu1)
OpenJDK 64-Bit Server VM (build 24.51-b03, mixed mode)
            Reporter: Kevin S. Clarke


When running the following command:

mvn javadoc:test-fix -Dforce=true -DfixMethodComment=false 
-DfixFieldComment=false -DfixTags=author -DdefaultAuthor=ksclarke 
-Dincludes=**/RdfLexiconTest.java

The expectation is that the @author tag will be added to a Javadoc comment 
above the class declaration.  The result is that the @author tag is added to 
the header (which is in a Javadoc comment) rather than a Javadoc comment above 
the class declaration.

This is an example of what our files look like:

/**
 * Copyright 2014 DuraSpace, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package org.fcrepo.kernel;

import static org.junit.Assert.assertTrue;

import org.junit.Test;

public class RdfLexiconTest {
 [...]
}

Changing our header notice to use slash-asterisk style:

/*
 *
 */

instead of Javadoc style "solves" the problem and the @author is added in the 
right place.  Fwiw, we use the license-maven-plugin to generate our headers.



--
This message was sent by Atlassian JIRA
(v6.1.6#6162)

Reply via email to