Re: upgrading the JavaDocs
Hello again,
Well after getting up to date with Maven and all the problems I have
reached to a solution. I will explain it here because I need your
opinion on this.
The idea is to make a general configuration of the javadoc plugin in
james parent POM, one that will not contain the APIviz doclet part.
This will be done in the pluginManagement section of the POM. This
general configuration will be for all projects that inherit from
parent.
After this, add the APIviz specific part to the javadoc module in
every module that has classes, so that the doclet will be called only
for those, and thus avoid the error.
The downside of this approach is that this cofiguration will have to
be made in every module and just server has 31. Also, the project will
have to be compiled manually before the site generation.
The addition will look like:
org.apache.maven.plugins
maven-javadoc-plugin
org.jboss.apiviz.APIviz
org.jboss.apiviz
apiviz
${apiviz.version}
-sourceclasspath
${project.build.outputDirectory}
p.s. I wrote to Trustin to see if we can make APIviz fail silently in
case of missing classes.
Bye,
--
Ioan Eugen Stan
http://ieugen.blogspot.com/
-
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
Hello again,
Among other things this week I struggled to get the APIviz thing
working and I have got myself into a dead end. The problem why APIviz
fails is that james server has pom packaging, so no target/classes for
it (no compile phase).
I figured I could skip the APIviz javadoc generation for pom packaged
projects by using profiles but I don't seem to get the activation part
working.
I have attached a patch for james-project pom. The file based
activation does not seem to work. I also tried to activate on
${project.build.outputDirectory}/classes/META-INF/MANIFEST.MF
but still no success.
Am I missing something here?
p.s. I used the maven help plugin to see effective-pom and all-profiles.
Regards,
--
Ioan Eugen Stan
http://ieugen.blogspot.com/
-
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
>>
>> Hi Ioan,
>>
>> I already did something similar, but it doesn't work.
>> Finally, I have created by hand the target/classes and target/test-classes.
>>
>> Now it generates the site with javadoc, but with standard pages, although
>> org.jboss.apiviz.APIviz is taken in the pom (looking in .m2 cache and in
>> Effective POM in eclipse).
>
> Well, inheritance is kind of tricky and can be of different types (the
> child config either replaces or adds to the parrent, check [1] ).
> I will also try to get a hang of it sometimes tomorrow.
>
> Bye,
>
> [1] http://maven.apache.org/pom.html#Inheritance
> --
> Ioan Eugen Stan
> http://ieugen.blogspot.com/
Well, I gave it a quick look and the first impressions are:
I tried mvn compile javadoc:javadoc and it failed with the same error
as with Eric. After, I tried mvn package which did not finish properly
because of hbase (missing running cluster.). After this I ran mvn
javadoc:javadoc again and it failed in the case of some packages
(missing classes directory), but with all the other cases it generated
the documentation very good.
mvn compile javadoc:javadoc does not compile all sources. I'm not that
great with maven, but I believe that with agregate projects you need
to do a build. So the ERROR message is genuine, because the classes
are not there and so APIviz can't determine the relationships between
classes properly.
Why is this happening, I don't know yet, but I'm guessing it's some
part Inheritance, some part aggregate.
If all the projects get compiled, everything would be ok.
The important part for APIviz is the line with:
-sourceclasspath
${project.build.outputDirectory}
That's the line that tells it where to find the classes.
Anyone with good Maven skills around here?
Just this for now, more later.
Bye,
--
Ioan Eugen Stan
http://ieugen.blogspot.com/
-
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
2011/9/11 Eric Charles : > On 11/09/11 11:55, Ioan Eugen Stan wrote: >> >> 2011/9/11 Eric Charles: >>> >>> Hi Ioan, >>> >>> snapshots are published >>> >>> https://repository.apache.org/content/groups/snapshots/org/apache/james/james-project/ >>> >>> but mailbox pom.xml still points to 1.6 >>> I upgraded locally to 1.7-SNAPSHOT, tried 'mvn site', and got error. >> >> Try to compile first. Run mvn compile javadoc:javadoc. >> > > Hi Ioan, > > I already did something similar, but it doesn't work. > Finally, I have created by hand the target/classes and target/test-classes. > > Now it generates the site with javadoc, but with standard pages, although > org.jboss.apiviz.APIviz is taken in the pom (looking in .m2 cache and in > Effective POM in eclipse). Well, inheritance is kind of tricky and can be of different types (the child config either replaces or adds to the parrent, check [1] ). I will also try to get a hang of it sometimes tomorrow. Bye, [1] http://maven.apache.org/pom.html#Inheritance -- Ioan Eugen Stan http://ieugen.blogspot.com/ - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
On 11/09/11 11:55, Ioan Eugen Stan wrote: 2011/9/11 Eric Charles: Hi Ioan, snapshots are published https://repository.apache.org/content/groups/snapshots/org/apache/james/james-project/ but mailbox pom.xml still points to 1.6 I upgraded locally to 1.7-SNAPSHOT, tried 'mvn site', and got error. Try to compile first. Run mvn compile javadoc:javadoc. Hi Ioan, I already did something similar, but it doesn't work. Finally, I have created by hand the target/classes and target/test-classes. Now it generates the site with javadoc, but with standard pages, although org.jboss.apiviz.APIviz is taken in the pom (looking in .m2 cache and in Effective POM in eclipse). Thx. -- Eric http://about.echarles.net - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
2011/9/11 Eric Charles : > Hi Ioan, > > snapshots are published > https://repository.apache.org/content/groups/snapshots/org/apache/james/james-project/ > > but mailbox pom.xml still points to 1.6 > I upgraded locally to 1.7-SNAPSHOT, tried 'mvn site', and got error. Try to compile first. Run mvn compile javadoc:javadoc. -- Ioan Eugen Stan http://ieugen.blogspot.com/ - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
Proactive Norman :) On 11/09/11 04:32, Norman Maurer wrote: Hi there, I requested to get it uploaded to maven central https://issues.jboss.org/browse/APIVIZ-9 bye norman Am Samstag, 10. September 2011 schrieb Ioan Eugen Stan< stan.ieu...@gmail.com>: 2011/9/10 Eric Charles: +1 Looks great and very instructive Does mvn javadocs:javadocs still works without apiviz installed locally? Thx, Eric It will throw an error if it can't download the maven plugin (as it does with all plugins) and default to normal Javadoc if graphics is not installed. So unless the jboss maven repository is down it should not be a problem. Regards, -- Ioan Eugen Stan http://ieugen.blogspot.com/ - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org -- Eric http://about.echarles.net - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
Hi Ioan, snapshots are published https://repository.apache.org/content/groups/snapshots/org/apache/james/james-project/ but mailbox pom.xml still points to 1.6 I upgraded locally to 1.7-SNAPSHOT, tried 'mvn site', and got error. With 1.6, javadoc was fine. Maybe it needs apiviz executable in path (will try later, or you can remove it from your path and see result :) Thx. [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.7:aggregate (javadocs-for-site) on project apache-james-mailbox: An error has occurred in JavaDocs report generation: [ERROR] Exit code: 1 - javadoc: error - /Users/echarles/dev/apache-james/current/mailbox/target/classes doesn't exist or is not readable. [ERROR] [ERROR] Command line was: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home/bin/javadoc -J-Xmx1024m -J-Xms256m @options @packages [ERROR] [ERROR] Refer to the generated Javadoc files in '/Users/echarles/dev/apache-james/current/mailbox/target/site/apidocs' dir. [ERROR] -> [Help 1] org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.7:aggregate (javadocs-for-site) on project apache-james-mailbox: An error has occurred in JavaDocs report generation: Exit code: 1 - javadoc: error - /Users/echarles/dev/apache-james/current/mailbox/target/classes doesn't exist or is not readable. Command line was: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home/bin/javadoc -J-Xmx1024m -J-Xms256m @options @packages Refer to the generated Javadoc files in '/Users/echarles/dev/apache-james/current/mailbox/target/site/apidocs' dir. On 10/09/11 10:41, Ioan Eugen Stan wrote: Hello, Well, I've added the changes and commited them but when I compiled james server nothing happened. Does Maven downloads the parent POM every time or do I have to clean the cache? Or it downloads the released version of the POM so it will be available when the new SNAPSHOT/RELEASE version is published ? Bye, -- Eric http://about.echarles.net - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
Hi there, I requested to get it uploaded to maven central https://issues.jboss.org/browse/APIVIZ-9 bye norman Am Samstag, 10. September 2011 schrieb Ioan Eugen Stan < stan.ieu...@gmail.com>: > 2011/9/10 Eric Charles : >> +1 Looks great and very instructive >> >> Does mvn javadocs:javadocs still works without apiviz installed locally? >> >> Thx, >> Eric > > It will throw an error if it can't download the maven plugin (as it > does with all plugins) and default to normal Javadoc if graphics is > not installed. So unless the jboss maven repository is down it should > not be a problem. > > Regards, > -- > Ioan Eugen Stan > http://ieugen.blogspot.com/ > > - > To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org > For additional commands, e-mail: server-dev-h...@james.apache.org > >
Re: upgrading the JavaDocs
Hello, Well, I've added the changes and commited them but when I compiled james server nothing happened. Does Maven downloads the parent POM every time or do I have to clean the cache? Or it downloads the released version of the POM so it will be available when the new SNAPSHOT/RELEASE version is published ? Bye, -- Ioan Eugen Stan http://ieugen.blogspot.com/ - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
2011/9/10 Eric Charles : > +1 Looks great and very instructive > > Does mvn javadocs:javadocs still works without apiviz installed locally? > > Thx, > Eric It will throw an error if it can't download the maven plugin (as it does with all plugins) and default to normal Javadoc if graphics is not installed. So unless the jboss maven repository is down it should not be a problem. Regards, -- Ioan Eugen Stan http://ieugen.blogspot.com/ - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
+1 Looks great and very instructive Does mvn javadocs:javadocs still works without apiviz installed locally? Thx, Eric On 10/09/11 07:35, Norman Maurer wrote: Yeah very nice :) Bye, Norman 2011/9/10 Felix Knecht: Hi On 09/10/2011 02:25 PM, Ioan Eugen Stan wrote: Hello, I have deployed the new mailbox website after building and integrating ApiViz [1], [2]. Now, the generated Javadocs have integrated diagrams. You can take a look at [3]. The next step is to work on the CSS a bit, but before that I wish to integrate ApiViz with the whole project. To do this I have to make some changes higher in the POM hierarchy (maybe james-project POM or james-parent POM). The changes are: 1. add the ApiViz repository. 2. modify the maven-javadoc-plugin to build apiviz docs (ApiViz requires graphics package to build, if not found defaults to standard Javadoc). I have attached a patch file for mailbox that fixes the issue but I really wish to implement things upstream so the the Javadoc generation will be inherited by all James projects. The only problem I have is that I don't know what pom to modify, without polluting things. In order for maven-javadoc-plugin with ApiViz to do it's job, we have to implement it in the pluginManagement section. What do you think? Sounds and looks good. I think it's following pom you want to modify: james-project POM (https://svn.apache.org/repos/asf/james/project/trunk/project/pom.xml) Regards Felix [1] https://issues.apache.org/jira/browse/JAMES-1256 [2] http://code.google.com/p/apiviz/ [3] http://james.apache.org/mailbox/apache-james-mailbox-hbase/apidocs/ Regards, - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org -- Eric http://about.echarles.net - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
Yeah very nice :) Bye, Norman 2011/9/10 Felix Knecht : > Hi > > On 09/10/2011 02:25 PM, Ioan Eugen Stan wrote: >> >> Hello, >> >> I have deployed the new mailbox website after building and integrating >> ApiViz [1], [2]. Now, the generated Javadocs have integrated diagrams. >> You can take a look at [3]. >> The next step is to work on the CSS a bit, but before that I wish to >> integrate ApiViz with the whole project. >> >> To do this I have to make some changes higher in the POM hierarchy >> (maybe james-project POM or james-parent POM). The changes are: >> >> 1. add the ApiViz repository. >> 2. modify the maven-javadoc-plugin to build apiviz docs (ApiViz >> requires graphics package to build, if not found defaults to standard >> Javadoc). >> >> I have attached a patch file for mailbox that fixes the issue but I >> really wish to implement things upstream so the the Javadoc generation >> will be inherited by all James projects. >> The only problem I have is that I don't know what pom to modify, >> without polluting things. In order for maven-javadoc-plugin with >> ApiViz to do it's job, we have to implement it in the pluginManagement >> section. >> >> What do you think? > > Sounds and looks good. I think it's following pom you want to modify: > > james-project POM > (https://svn.apache.org/repos/asf/james/project/trunk/project/pom.xml) > > Regards > Felix > >> >> [1] https://issues.apache.org/jira/browse/JAMES-1256 >> [2] http://code.google.com/p/apiviz/ >> [3] http://james.apache.org/mailbox/apache-james-mailbox-hbase/apidocs/ >> >> Regards, > > > - > To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org > For additional commands, e-mail: server-dev-h...@james.apache.org > > - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
Re: upgrading the JavaDocs
Hi On 09/10/2011 02:25 PM, Ioan Eugen Stan wrote: Hello, I have deployed the new mailbox website after building and integrating ApiViz [1], [2]. Now, the generated Javadocs have integrated diagrams. You can take a look at [3]. The next step is to work on the CSS a bit, but before that I wish to integrate ApiViz with the whole project. To do this I have to make some changes higher in the POM hierarchy (maybe james-project POM or james-parent POM). The changes are: 1. add the ApiViz repository. 2. modify the maven-javadoc-plugin to build apiviz docs (ApiViz requires graphics package to build, if not found defaults to standard Javadoc). I have attached a patch file for mailbox that fixes the issue but I really wish to implement things upstream so the the Javadoc generation will be inherited by all James projects. The only problem I have is that I don't know what pom to modify, without polluting things. In order for maven-javadoc-plugin with ApiViz to do it's job, we have to implement it in the pluginManagement section. What do you think? Sounds and looks good. I think it's following pom you want to modify: james-project POM (https://svn.apache.org/repos/asf/james/project/trunk/project/pom.xml) Regards Felix [1] https://issues.apache.org/jira/browse/JAMES-1256 [2] http://code.google.com/p/apiviz/ [3] http://james.apache.org/mailbox/apache-james-mailbox-hbase/apidocs/ Regards, - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
upgrading the JavaDocs
Hello, I have deployed the new mailbox website after building and integrating ApiViz [1], [2]. Now, the generated Javadocs have integrated diagrams. You can take a look at [3]. The next step is to work on the CSS a bit, but before that I wish to integrate ApiViz with the whole project. To do this I have to make some changes higher in the POM hierarchy (maybe james-project POM or james-parent POM). The changes are: 1. add the ApiViz repository. 2. modify the maven-javadoc-plugin to build apiviz docs (ApiViz requires graphics package to build, if not found defaults to standard Javadoc). I have attached a patch file for mailbox that fixes the issue but I really wish to implement things upstream so the the Javadoc generation will be inherited by all James projects. The only problem I have is that I don't know what pom to modify, without polluting things. In order for maven-javadoc-plugin with ApiViz to do it's job, we have to implement it in the pluginManagement section. What do you think? [1] https://issues.apache.org/jira/browse/JAMES-1256 [2] http://code.google.com/p/apiviz/ [3] http://james.apache.org/mailbox/apache-james-mailbox-hbase/apidocs/ Regards, -- Ioan Eugen Stan http://ieugen.blogspot.com/ - To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
