Improving JavaDoc

core/src/main/java/org/mapstruct/package-info.java

@@ -0,0 +1,31 @@
+/**
+ *  Copyright 2012-2013 Gunnar Morling (http://www.gunnarmorling.de/)
+ *  and/or other contributors as indicated by the @authors tag. See the
+ *  copyright.txt file in the distribution for a full listing of all
+ *  contributors.
+ *
+ *  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.
+ */
+/**
+ * <p>
+ * MapStruct is a code generator which simplifies the implementation of mappings between Java bean types by generating
+ * mapping code at compile time, following a convention-over-configuration approach. The generated code uses plain
+ * method invocations and thus is fast and type-safe.
+ * </p>
+ * <p>
+ * This package contains several annotations which allow to configure how mapper interfaces are generated.
+ * </p>
+ *
+ * @see <a href="http://mapstruct.org/">MapStruct reference documentation</a>
+ */
+package org.mapstruct;

distribution/pom.xml

@@ -62,9 +62,13 @@
                     <packagesheader>MapStruct Packages</packagesheader>
                     <doctitle>MapStruct ${project.version}</doctitle>
                     <windowtitle>MapStruct ${project.version}</windowtitle>
+                    <bottom>
+                        <![CDATA[Copyright &copy; ${project.inceptionYear}-{currentYear} <a href="http://mapstruct.org/">Gunnar Morling</a>; All rights reserved. Released under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache Software License 2.0</a>.]]>
+                    </bottom>
+
                     <groups>
                         <group>
-                            <title>MapStruct</title>
+                            <title>MapStruct API</title>
                             <packages>org.mapstruct*</packages>
                         </group>
                         <group>

processor/pom.xml

@@ -40,15 +40,21 @@
     </properties>
 
     <dependencies>
+        <!-- Compile -->
         <dependency>
             <groupId>org.freemarker</groupId>
             <artifactId>freemarker</artifactId>
         </dependency>
+
+        <!-- Compile-only; Using "provided" scope as there is no such scope in Maven;
+             these dependencies are not required at runtime, only for prism generation -->
         <dependency>
             <groupId>com.jolira</groupId>
             <artifactId>hickory</artifactId>
             <scope>provided</scope>
         </dependency>
+
+        <!-- Test -->
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>mapstruct</artifactId>

processor/src/main/java/org/mapstruct/ap/conversion/Conversions.java

@@ -29,6 +29,11 @@ import org.mapstruct.ap.util.TypeUtil;
 
 import static org.mapstruct.ap.conversion.ReverseConversion.reverse;
 
+/**
+ * Holds built-in {@link Conversion}s such as from {@code int} to {@code String}.
+ *
+ * @author Gunnar Morling
+ */
 public class Conversions {
 
     private TypeUtil typeUtil;

processor/src/main/java/org/mapstruct/ap/model/source/MappedProperty.java

@@ -20,6 +20,12 @@ package org.mapstruct.ap.model.source;
 
 import org.mapstruct.ap.model.Type;
 
+/**
+ * Represents a property mapped from source to target with the names of its
+ * accessor methods.
+ *
+ * @author Gunnar Morling
+ */
 public class MappedProperty {
 
     private final String sourceName;

processor/src/main/java/org/mapstruct/ap/model/source/Mapping.java

@@ -21,6 +21,11 @@ package org.mapstruct.ap.model.source;
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.AnnotationValue;
 
+/**
+ * Represents a property mapping as configured via {@code @Mapping}.
+ *
+ * @author Gunnar Morling
+ */
 public class Mapping {
 
     private final String sourceName;

processor/src/main/java/org/mapstruct/ap/model/source/Method.java

@@ -23,7 +23,12 @@ import javax.lang.model.element.ExecutableElement;
 
 import org.mapstruct.ap.model.Type;
 
-
+/**
+ * Represents a mapping method with source and target type and the mappings
+ * between the properties of source and target type.
+ *
+ * @author Gunnar Morling
+ */
 public class Method {
 
     private final Type declaringMapper;

processor/src/main/java/org/mapstruct/ap/model/source/Parameter.java

@@ -20,6 +20,11 @@ package org.mapstruct.ap.model.source;
 
 import org.mapstruct.ap.model.Type;
 
+/**
+ * A parameter of a mapping method.
+ *
+ * @author Gunnar Morling
+ */
 public class Parameter {
 
     private final String name;

processor/src/main/java/org/mapstruct/ap/package-info.java

@@ -0,0 +1,25 @@
+/**
+ *  Copyright 2012-2013 Gunnar Morling (http://www.gunnarmorling.de/)
+ *  and/or other contributors as indicated by the @authors tag. See the
+ *  copyright.txt file in the distribution for a full listing of all
+ *  contributors.
+ *
+ *  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.
+ */
+/**
+ * <p>
+ * This package and it sub-packages contain the implementation of the MapStruct annotation processor. Application code
+ * using MapStruct should never work with these types directly.
+ * </p>
+ */
+package org.mapstruct.ap;