Bug 437794

Summary: Unable to build Javadoc with maven
Product: [Modeling] Sirius Reporter: Daniel Liabeuf <daniel.liabeuf>
Component: DocumentationAssignee: Projet Inbox <sirius.doc-inbox>
Status: NEW --- QA Contact:
Severity: normal    
Priority: P3 CC: cedric.brun, esteban.dugueperoux, pierre-charles.david
Version: unspecifiedKeywords: triaged
Target Milestone: ---   
Hardware: PC   
OS: Windows 7   
Whiteboard:

Description Daniel Liabeuf CLA 2014-06-20 04:19:06 EDT
'''Overview:''' Currently it is not possible to easyly generate javadoc with maven.

'''Steps to Reproduce:'''
 1. Go top-level directory of the clone
 1. and issue a simple //mvn javadoc:javadoc//

'''Actual Results:'''
{{{
[ERROR] Failed to execute goal on project org.eclipse.sirius.ext.e3: Could not r
esolve dependencies for project org.eclipse.sirius:org.eclipse.sirius.ext.e3:ecl
ipse-plugin:2.0.0-SNAPSHOT: Could not find artifact org.eclipse.sirius:org.eclip
se.sirius.ext.base:jar:2.0.0-SNAPSHOT -> [Help 1]
}}}

'''Build Date:''' 20 Jun 2014
Comment 1 Esteban DUGUEPEROUX CLA 2014-06-27 10:30:44 EDT
I reproduce. Thanks for your report.
Comment 2 Cedric Brun CLA 2014-06-27 10:41:34 EDT
http://intellectualcramps.wordpress.com/2010/09/04/generating-javadoc-with-maven-3-and-tycho/

This might be a useful reference (though slightly old)
Comment 3 Daniel Liabeuf CLA 2014-08-27 11:47:36 EDT
Eclipse GEF use Maven/Tycho and generated source... it's a mess.
http://git.eclipse.org/c/gef/org.eclipse.gef.git/tree/org.eclipse.gef.doc.isv
Comment 4 Mikaël Barbero CLA 2014-08-27 12:03:23 EDT
EMF Compare recently add javadoc generation to its tycho build. See http://git.eclipse.org/c/emfcompare/org.eclipse.emf.compare.git/tree/plugins/org.eclipse.emf.compare.doc/pom.xml#n147 for how I did it.
Comment 5 Mikaël Barbero CLA 2014-08-27 12:12:20 EDT
Tricky thing, you have to depend on every bundles that you want the javadoc to be build for. I did it through the jars.extra.classpath of the build.properties file. It avoids your doc plugin to have OSGi runtime dependency on other bundles. This is only a build dependency.

See http://git.eclipse.org/c/emfcompare/org.eclipse.emf.compare.git/tree/plugins/org.eclipse.emf.compare.doc/build.properties#n17
Comment 6 Pierre-Charles David CLA 2014-09-29 05:25:01 EDT
The thread at https://dev.eclipse.org/mhonarc/lists/cross-project-issues-dev/msg11132.html also contains some poitners (I have not looked at them).