[jira] [Commented] (GORA-166) Substantiate Javadoc for Gora

["Lewis John McGibbney (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/GORA-166?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13561413#comment-13561413 ] 

Lewis John McGibbney commented on GORA-166:
-------------------------------------------

We can get the Javadoc looking much better by 
* specifying version 2.8 of the Maven Javadoc plugin in parent pom.xml
* {code}
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>${maven-javadoc-plugin.version}</version>
  <configuration>
    <!-- Apple's JVM sometimes requires more memory  -->
    <additionalJOption>-J-Xmx1024m</additionalJOption>
  </configuration>
</plugin>
{code}
* adding the following to the '''release''' profile in parent pom
{code}
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>${maven-javadoc-plugin.version}</version>
  <executions>
    <execution>
      <id>attach-javadocs</id>
      <goals>
        <goal>jar</goal>
      </goals>
      <configuration>
        <quiet>true</quiet>
        <archive>
          <manifest>
            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
            <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
          </manifest>
          <manifestEntries>
            <Implementation-Build>${implementation.build}</Implementation-Build>
            <Implementation-Build-Date>${maven.build.timestamp}</Implementation-Build-Date>
            <X-Compile-Source-JDK>${javac.src.version}</X-Compile-Source-JDK>
            <X-Compile-Target-JDK>${javac.target.version}</X-Compile-Target-JDK>
          </manifestEntries>
        </archive>
      </configuration>
    </execution>
  </executions>
</plugin>
* Add a package.info similar to this one [0] at the base of every package we wish to annotate.

This will help us in rapidly improving the Javadoc for future releases.

I've not put this into a patch for the time being as I am not able to check out Gora source (I'm on a new box)... I will need to wait until later.

[0] http://svn.apache.org/repos/asf/any23/trunk/api/src/main/java/org/apache/any23/configuration/package-info.java
{code}
                
> Substantiate Javadoc for Gora
> -----------------------------
>
>                 Key: GORA-166
>                 URL: https://issues.apache.org/jira/browse/GORA-166
>             Project: Apache Gora
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 0.2.1
>            Reporter: Lewis John McGibbney
>             Fix For: 0.4
>
>
> Having a look at the recently published apache-gora-0.2.1 Javadoc's [0] it becomes quite clear that Javadoc's were something which never really caught on in Gora ;)
> This is a fairly substantial issue so incremental patches is probably the best way to go.
> [0] http://gora.apache.org/docs/current/apidocs-0.2.1/index.html

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira