Javadocs?

[Steve Bennett]

Hi all,
I notice javadoc comments in some code, so I was wondering if
there's an easy way to build the javadoc? No Maven target?
Alternatively, are they online anywhere?

Thanks,
Steve

[Steve Bennett]

Hi Steve,

The following command, run in the svn checkout directory, seems to do the trick:

javadoc -sourcepath
uk.ac.osswatch.simal.core\src\main\java;uk.ac.osswatch.simal.web;uk.ac.osswatch.simal.ssmm;uk.ac.osswatch.simal.rest;uk.ac.osswatch.simal.forrest.plugins
-subpackages uk.ac.osswatch.simal

It generates a lot of errors though - perhaps something to do with the
classpath not set right.

Steve

[Ross Gardler]

On 14/01/2011 04:44, Steve Bennett wrote:
> Hi Steve,
>
> The following command, run in the svn checkout directory, seems to do the trick:
>
> javadoc -sourcepath
> uk.ac.osswatch.simal.core\src\main\java;uk.ac.osswatch.simal.web;uk.ac.osswatch.simal.ssmm;uk.ac.osswatch.simal.rest;uk.ac.osswatch.simal.forrest.plugins
> -subpackages uk.ac.osswatch.simal

Thanks for answering your own question. I've added this to
http://code.google.com/p/simal/wiki/JavaDocs and added an issue to
generate the javadocs as part of the release process.

Ross

[Sander W G van der Waal]

> From: simal...@googlegroups.com [mailto:simal...@googlegroups.com] On
> Behalf Of Ross Gardler
> Sent: 14 January 2011 15:40
> To: simal...@googlegroups.com
> Subject: Re: [simal-users] Re: Javadocs?

Alternatively, you can run 'mvn site' in the root of a module. The site is
generated in the target/site folder of the module and contains several reports.
I set this up for the cobertura test coverage reports, but it now also
generates javadoc. The drawback is that it will only generate the javadoc
for that module (core or rest or web).
I'll add this info to the JavaDocs wiki page.
(Note that the src/test/java packages will be skipped by this plugin).

Sander

> Ross
>
> --
> You received this message because you are subscribed to the Google Groups
> "simal-users" group.
> To post to this group, send email to simal...@googlegroups.com.
> To unsubscribe from this group, send email to simal-
> users+un...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/simal-
> users?hl=en.

[Ross Gardler]

On 17/01/2011 09:47, Sander W G van der Waal wrote:
> ou can run 'mvn site' in the root of a module. The site is
> generated in the target/site folder of the module and contains several reports.
> I set this up for the cobertura test coverage reports, but it now also
> generates javadoc.

Well that's easier.

> The drawback is that it will only generate the javadoc
> for that module (core or rest or web).

Another reason to make a master project to automatically build all the
sub modules - http://code.google.com/p/simal/issues/detail?id=202

> I'll add this info to the JavaDocs wiki page.
> (Note that the src/test/java packages will be skipped by this plugin).

Thanks

Ross

--
rgar...@apache.org
@rgardler