trunk/apache-rat-plugin/src/site/apt/examples/site.apt.vm

~~   Licensed to the Apache Software Foundation (ASF) under one or more
~~   contributor license agreements.  See the NOTICE file distributed with
~~   this work for additional information regarding copyright ownership.
~~   The ASF licenses this file to You 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.

 ---------------------------------------
 Adding a report to the generated site
 ---------------------------------------

Adding a report to the generated site

  The typical use case is that you want the plugin to run whenever you invoke

------------------------------------------------------------------
  mvn site
------------------------------------------------------------------

  That way, the report will be added to the generated
  site. This is done by simply adding the following section to
  your POM:

------------------------------------------------------------------
  <reporting>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.rat</groupId>
        <artifactId>apache-rat-plugin</artifactId>
        <version>${currentVersion}</version>
      </plugin>
      ...
    </plugins>
  </reporting>
------------------------------------------------------------------