Improve support for Maven

[GoogleCodeExporter]

Maven allows doclets to be specified as an artifact. Deploying Doclava to the 
public Maven repository would allow developers to use Doclava with simple 
cut-and-paste configuration, and no extra download.

http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.h
tml

Original issue reported on code.google.com by bjdod...@gmail.com on 28 Aug 2010 at 10:44

[GoogleCodeExporter]

Original comment by bjdod...@gmail.com on 31 Aug 2010 at 7:43

• Changed title: Improve support for Maven

[GoogleCodeExporter]

Hi all guys,
please check out the attached patch, it adds the pom.xml required by maven to 
deploy the project on Sonatype's Nexus. NOTE: I didn't have the need to modify 
your project structure, I adapted the maven build to your preferences.

To run the whole process, just launch

{{{ mvn clean package }}}

To release the package, just launch

{{{ mvn release:prepare -Dgpg.passphrase=<thephrase> }}}

then

{{{ mvn release:perform }}}

Please refer also to official Sonatype's documentation for preconditions and 
steps to perform after the last step: 
https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage
+Guide

On a side note, I though it was a good idea adding few metadata to enrich the 
META-INF/MANIFEST and the missing LICENSE file.

I tested the packaging using Maven3.

Hope this helps, feel free to ping me if something goes wrong.
Thanks in advance!
Simo

Original comment by simone.t...@gmail.com on 7 Nov 2010 at 2:58

Attachments:

• Issue_10_Improve_support_for_Maven.patch

[GoogleCodeExporter]

Great, thank you! I will look into getting us registered properly.

Original comment by bjdod...@gmail.com on 7 Nov 2010 at 6:55

[GoogleCodeExporter]

Hi bjdodson!
the only change respect your original ant build, is the jar artifact name that 
contains the version number, I mean

{{{ build/doclava-1.0.0-SNAPSHOT.jar }}}

instead of

{{{ build/doclava.jar }}}

let mw know if you prefer having the second one, it's very easy to do so I can 
provide you a new patche very quicly.

The only trouble I have: when generating the javadoc using the doclet, 
documentation is placed under

{{{ build/apidocs/docs }}}

instead of just

{{{ build/apidocs }}}

is this the desired behavior or something misconfigured?
Thanks in advance!
Simo

Original comment by simone.t...@gmail.com on 7 Nov 2010 at 7:37

[GoogleCodeExporter]

Hi all,
just noticed you successfully deployed doclava on Maven Central Repo!!! 
http://repo2.maven.org/maven2/com/google/doclava/doclava/1.0.0/

That's cool, thanks a lot! I think that issue can be closed!
Kudos for you!
Simo

Original comment by simone.t...@gmail.com on 11 Nov 2010 at 7:18

[GoogleCodeExporter]

Yep, we just got the approval and finished up this morning! Thanks again for 
your patch and for pushing us to get this done.

Original comment by bjdod...@gmail.com on 11 Nov 2010 at 7:19

[GoogleCodeExporter]

Original comment by bjdod...@gmail.com on 11 Nov 2010 at 7:20

• Changed state: Done

[GoogleCodeExporter]

As for your question about the apidocs/docs layout, we designed our filesystem 
layout to work well in standalone mode (or with Ant as a build system), and not 
really thinking about Maven. But you can change the output directory with the 
"-d" argument:

http://code.google.com/p/doclava/wiki/CommandLineArguments

Original comment by bjdod...@gmail.com on 11 Nov 2010 at 7:23

[GoogleCodeExporter]

thanks to you guys for creating this amazing tool, providing help for the 
deploy has been a pleasure for me! :)

Original comment by simone.t...@gmail.com on 11 Nov 2010 at 7:28