Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMikaël Barbero2014-07-25 14:59:55 +0000
committerMikaël Barbero2014-07-25 15:12:18 +0000
commitcfc11e371cf521d7f504e59e87b0faf1fddd942f (patch)
tree32838a6aafb049b3c38b25f1296b564979997839
parent998abd016f179ba509bfcc3ddd20b9a8f12c7fd1 (diff)
downloadorg.eclipse.emf.compare-cfc11e371cf521d7f504e59e87b0faf1fddd942f.tar.gz
org.eclipse.emf.compare-cfc11e371cf521d7f504e59e87b0faf1fddd942f.tar.xz
org.eclipse.emf.compare-cfc11e371cf521d7f504e59e87b0faf1fddd942f.zip
Add javadoc to doc plugin.
This is automatically generated when profile javadoc is activated. There will be dead links in the doc if it is not activated. The javadoc generation is not run from the main profile to be able to keep a fast build for gerrit (where javadoc generation is not useful). Change-Id: Ia2201197c37e577da191450c6854f70fded47801
-rw-r--r--packaging/org.eclipse.emf.compare.gendoc/.classpath1
-rw-r--r--packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r-sources.jarbin1831240 -> 0 bytes
-rw-r--r--packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.jarbin1853446 -> 0 bytes
-rw-r--r--packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.pom9
-rw-r--r--packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/maven-metadata-local.xml12
-rw-r--r--packaging/org.eclipse.emf.compare.gendoc/pom.xml7
-rw-r--r--packaging/org.eclipse.emf.compare.gendoc/src/org/eclipse/emf/compare/doc/WikiTextToHTML.java98
-rw-r--r--plugins/org.eclipse.emf.compare.doc/build.properties7
-rw-r--r--plugins/org.eclipse.emf.compare.doc/pom.xml91
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/developer/~javadoc.mediawiki0
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/index.mediawiki39
-rw-r--r--plugins/org.eclipse.emf.compare.doc/src/tutorial/tutorial.mediawiki3
12 files changed, 181 insertions, 86 deletions
diff --git a/packaging/org.eclipse.emf.compare.gendoc/.classpath b/packaging/org.eclipse.emf.compare.gendoc/.classpath
index 73bef9419..5ac08e0fe 100644
--- a/packaging/org.eclipse.emf.compare.gendoc/.classpath
+++ b/packaging/org.eclipse.emf.compare.gendoc/.classpath
@@ -2,7 +2,6 @@
<classpath>
<classpathentry kind="src" path="src"/>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7"/>
- <classpathentry kind="lib" path="mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.jar" sourcepath="mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r-sources.jar"/>
<classpathentry kind="lib" path="mvn/org/eclipse/mylyn/org.eclipse.mylyn.wikitext.core/1.9.0.20131007-2055/org.eclipse.mylyn.wikitext.core-1.9.0.20131007-2055.jar" sourcepath="mvn/org/eclipse/mylyn/org.eclipse.mylyn.wikitext.core/1.9.0.20131007-2055/org.eclipse.mylyn.wikitext.core-1.9.0.20131007-2055-sources.jar"/>
<classpathentry kind="lib" path="mvn/org/eclipse/mylyn/org.eclipse.mylyn.wikitext.mediawiki.core/1.9.0.20131007-2055/org.eclipse.mylyn.wikitext.mediawiki.core-1.9.0.20131007-2055.jar" sourcepath="mvn/org/eclipse/mylyn/org.eclipse.mylyn.wikitext.mediawiki.core/1.9.0.20131007-2055/org.eclipse.mylyn.wikitext.mediawiki.core-1.9.0.20131007-2055-sources.jar"/>
<classpathentry kind="output" path="bin"/>
diff --git a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r-sources.jar b/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r-sources.jar
deleted file mode 100644
index 363c8d231..000000000
--- a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r-sources.jar
+++ /dev/null
Binary files differ
diff --git a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.jar b/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.jar
deleted file mode 100644
index 172c4d4cd..000000000
--- a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.jar
+++ /dev/null
Binary files differ
diff --git a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.pom b/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.pom
deleted file mode 100644
index 118d4ce78..000000000
--- a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/3.2.0.201312181205-r/org.eclipse.jgit-3.2.0.201312181205-r.pom
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <modelVersion>4.0.0</modelVersion>
- <groupId>org.eclipse.jgit</groupId>
- <artifactId>org.eclipse.jgit</artifactId>
- <version>3.2.0.201312181205-r</version>
- <description>POM was created from install:install-file</description>
-</project>
diff --git a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/maven-metadata-local.xml b/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/maven-metadata-local.xml
deleted file mode 100644
index 474b54fb6..000000000
--- a/packaging/org.eclipse.emf.compare.gendoc/mvn/org/eclipse/jgit/org.eclipse.jgit/maven-metadata-local.xml
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
- <groupId>org.eclipse.jgit</groupId>
- <artifactId>org.eclipse.jgit</artifactId>
- <versioning>
- <release>3.2.0.201312181205-r</release>
- <versions>
- <version>3.2.0.201312181205-r</version>
- </versions>
- <lastUpdated>20140120082903</lastUpdated>
- </versioning>
-</metadata>
diff --git a/packaging/org.eclipse.emf.compare.gendoc/pom.xml b/packaging/org.eclipse.emf.compare.gendoc/pom.xml
index b06c5974d..bdf0fed99 100644
--- a/packaging/org.eclipse.emf.compare.gendoc/pom.xml
+++ b/packaging/org.eclipse.emf.compare.gendoc/pom.xml
@@ -37,11 +37,6 @@
<artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId>
<version>1.9.0.20131007-2055</version>
</dependency>
- <dependency>
- <groupId>org.eclipse.jgit</groupId>
- <artifactId>org.eclipse.jgit</artifactId>
- <version>3.2.0.201312181205-r</version>
- </dependency>
</dependencies>
<build>
@@ -99,7 +94,7 @@
<manifestEntries>
<Class-Path>.</Class-Path>
<Rsrc-Main-Class>org.eclipse.emf.compare.doc.WikiTextToHTML</Rsrc-Main-Class>
- <Rsrc-Class-Path>./ org.eclipse.jgit-3.2.0.201312181205-r.jar org.eclipse.mylyn.wikitext.core-1.9.0.20131007-2055.jar org.eclipse.mylyn.wikitext.mediawiki.core-1.9.0.20131007-2055.jar</Rsrc-Class-Path>
+ <Rsrc-Class-Path>./ org.eclipse.mylyn.wikitext.core-1.9.0.20131007-2055.jar org.eclipse.mylyn.wikitext.mediawiki.core-1.9.0.20131007-2055.jar</Rsrc-Class-Path>
</manifestEntries>
</archive>
</configuration>
diff --git a/packaging/org.eclipse.emf.compare.gendoc/src/org/eclipse/emf/compare/doc/WikiTextToHTML.java b/packaging/org.eclipse.emf.compare.gendoc/src/org/eclipse/emf/compare/doc/WikiTextToHTML.java
index 419c3e348..a2e58fb9d 100644
--- a/packaging/org.eclipse.emf.compare.gendoc/src/org/eclipse/emf/compare/doc/WikiTextToHTML.java
+++ b/packaging/org.eclipse.emf.compare.gendoc/src/org/eclipse/emf/compare/doc/WikiTextToHTML.java
@@ -32,16 +32,10 @@ import java.nio.file.SimpleFileVisitor;
import java.nio.file.StandardCopyOption;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
-import java.util.Calendar;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
-import org.eclipse.jgit.api.DescribeCommand;
-import org.eclipse.jgit.api.Git;
-import org.eclipse.jgit.api.errors.GitAPIException;
-import org.eclipse.jgit.lib.Repository;
-import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
import org.eclipse.mylyn.internal.wikitext.core.parser.builder.DefaultSplittingStrategy;
import org.eclipse.mylyn.internal.wikitext.core.parser.builder.NoSplittingStrategy;
import org.eclipse.mylyn.internal.wikitext.core.parser.builder.SplitOutlineItem;
@@ -116,8 +110,8 @@ public class WikiTextToHTML {
private boolean genEclipseHelp;
private boolean genWebsite;
-
- private static java.util.Date NOW = Calendar.getInstance().getTime();
+
+ private String version;
public static void main(String[] args) throws Exception {
WikiTextToHTML wikiTextToHTML = new WikiTextToHTML();
@@ -132,6 +126,11 @@ public class WikiTextToHTML {
usage();
System.exit(1);
}
+ if (version == null || "".equals(version.trim())) {
+ System.err.println("Error: unable to find -version argument");
+ usage();
+ System.exit(1);
+ }
if (!genEclipseHelp && !genWebsite) {
System.err.println("Error: you must at least provide a -eclipsehelp or a -website option");
usage();
@@ -160,8 +159,6 @@ public class WikiTextToHTML {
foldersToCopy.add(targetRootFolder.resolve(sourceFolder).resolve("images"));
foldersToCopy.add(targetRootFolder.resolve(sourceFolder).resolve("resources"));
- targetWebsiteFolder = DEFAULT_FS.getPath("target", "website").resolve(gitDescribe());
- targetHelpFolder = DEFAULT_FS.getPath("help");
final Path resolvedTargetHelpFolder = targetRootFolder.resolve(targetHelpFolder);
if (genEclipseHelp) {
@@ -178,7 +175,11 @@ public class WikiTextToHTML {
@Override
public FileVisitResult visitFile(Path markupPath, BasicFileAttributes attrs) throws IOException {
if (mediawikiPattern.matches(markupPath)) {
- processFile(sourceFolder, targetWebsiteFolder, targetHelpFolder, markupPath);
+ if ("~javadoc.mediawiki".equals(markupPath.getFileName().toString())) {
+ processJavadoc(sourceFolder, targetWebsiteFolder, targetHelpFolder, markupPath);
+ } else {
+ processFile(sourceFolder, targetWebsiteFolder, targetHelpFolder, markupPath);
+ }
}
return FileVisitResult.CONTINUE;
}
@@ -237,7 +238,7 @@ public class WikiTextToHTML {
*
*/
private void usage() {
- System.out.println("Usage: wikiTextToHTML -location path [-eclipsehelp] [-website]");
+ System.out.println("Usage: wikiTextToHTML -location path -version version [-eclipsehelp path] [-website path]");
}
private void processCommandLineArgs(String[] args) throws Exception {
@@ -258,12 +259,26 @@ public class WikiTextToHTML {
if (option.equalsIgnoreCase("-eclipsehelp")) { //$NON-NLS-1$
genEclipseHelp = true;
+ targetHelpFolder = DEFAULT_FS.getPath(arg);
}
if (option.equalsIgnoreCase("-website")) { //$NON-NLS-1$
genWebsite = true;
+ targetWebsiteFolder = DEFAULT_FS.getPath(arg);
+ }
+
+ if (option.equalsIgnoreCase("-version")) { //$NON-NLS-1$
+ version = arg.trim();
}
}
+
+ if (targetHelpFolder.isAbsolute()) {
+ targetHelpFolder = targetRootFolder.relativize(targetHelpFolder);
+ }
+
+ if (targetWebsiteFolder.isAbsolute()) {
+ targetWebsiteFolder = targetRootFolder.relativize(targetWebsiteFolder);
+ }
}
private String getTitle(Path path) {
@@ -291,6 +306,35 @@ public class WikiTextToHTML {
return sb.toString().trim();
}
+ private void processJavadoc(final Path sourceFolder,
+ final Path targetWebsiteFolder,
+ final Path targetHelpFolder, Path markupPath)
+ throws IOException, FileNotFoundException,
+ UnsupportedEncodingException {
+ System.out.println("Processing " + markupPath);
+
+ Path relativeMarkupPath = targetRootFolder.resolve(sourceFolder).relativize(markupPath);
+
+ Path relativeTOCPath = relativeMarkupPath.getParent().resolve("toc-javadoc.xml");
+ Path targetTOC = targetHelpFolder.resolve(relativeTOCPath);
+ Path targetHelp = targetHelpFolder.resolve(changeFilename(relativeMarkupPath, ".html"));
+
+ if (genEclipseHelp) {
+ mkdirs(targetRootFolder.resolve(targetTOC));
+ mkdirs(targetRootFolder.resolve(targetHelp));
+ }
+
+ // for eclipse help
+ if (genEclipseHelp) {
+ final PathMatcher indexPattern = DEFAULT_FS.getPathMatcher("glob:**/index.mediawiki");
+ if (!indexPattern.matches(markupPath)) {
+ primaryTOCWriter.startTopic("Reference", null);
+ primaryTOCWriter.createLink(relativeTOCPath);
+ primaryTOCWriter.endTopic();
+ }
+ }
+ }
+
private void processFile(final Path sourceFolder,
final Path targetWebsiteFolder,
final Path targetHelpFolder, Path markupPath)
@@ -318,15 +362,13 @@ public class WikiTextToHTML {
final String markupContentWithTOC;
if ("index.mediawiki".equals(markupPath.getFileName().toString())) {
- markupContentWithTOC = markupContent.replaceFirst("=(.*)=", "=EMF Compare — $1=\n\nVersion " + gitDescribe() +"\n\n") +
- "\n\nVersion " + gitDescribe() +
- "\n\nLast updated " + NOW;
+ markupContentWithTOC = markupContent.replaceFirst("=(.*)=", "=EMF Compare — $1=\n\nVersion " + version +"\n\n") +
+ "\n\nVersion " + version;
} else {
Path relativeToRoot = targetHTML.getParent().relativize(targetWebsiteFolder.resolve("index.html"));
- markupContentWithTOC = markupContent.replaceFirst("=(.*)=", "=EMF Compare — $1=\n\nVersion " + gitDescribe() +"\n\n__TOC__\n\n") +
+ markupContentWithTOC = markupContent.replaceFirst("=(.*)=", "=EMF Compare — $1=\n\nVersion " + version +"\n\n__TOC__\n\n") +
"\n\nPart of ["+relativeToRoot+" EMF Compare Documentation]" +
- "\n\nVersion " + gitDescribe() +
- "\n\nLast updated " + NOW;
+ "\n\nVersion " + version;
}
if (performValidation(markupPath, markupContent)) {
@@ -350,6 +392,8 @@ public class WikiTextToHTML {
primaryTOCWriter.endTopic();
}
}
+ } else {
+ System.exit(1);
}
}
@@ -532,24 +576,6 @@ public class WikiTextToHTML {
}
}
- private String gitDescribe() {
- FileRepositoryBuilder builder = new FileRepositoryBuilder();
- try {
- Repository repo = builder.setWorkTree(new File("."))
- .readEnvironment() // scan environment GIT_* variables
- .findGitDir() // scan up the file system tree
- .build();
- Git git = new Git(repo);
- DescribeCommand command = git.describe();
- return command.call();
- } catch (IOException e) {
- new RuntimeException(e);
- } catch (GitAPIException e) {
- new RuntimeException(e);
- }
- return "";
- }
-
private void copy(final Path sourceFolder,
final Path targetFolder, String pattern) throws IOException {
final PathMatcher imageMatcher = DEFAULT_FS.getPathMatcher(pattern);
diff --git a/plugins/org.eclipse.emf.compare.doc/build.properties b/plugins/org.eclipse.emf.compare.doc/build.properties
index 74cfcbb68..c37adb5c2 100644
--- a/plugins/org.eclipse.emf.compare.doc/build.properties
+++ b/plugins/org.eclipse.emf.compare.doc/build.properties
@@ -13,3 +13,10 @@ bin.includes = META-INF/,\
about.html
src.includes = src/,\
about.html
+# for the javadoc generation.
+jars.extra.classpath = platform:/plugin/org.eclipse.emf.compare
+ platform:/plugin/org.eclipse.emf.compare.edit,\
+ platform:/plugin/org.eclipse.emf.compare.ide,\
+ platform:/plugin/org.eclipse.emf.compare.ide.ui,\
+ platform:/plugin/org.eclipse.emf.compare.rcp,\
+ platform:/plugin/org.eclipse.emf.compare.rcp.ui
diff --git a/plugins/org.eclipse.emf.compare.doc/pom.xml b/plugins/org.eclipse.emf.compare.doc/pom.xml
index 942791425..ddfc2a309 100644
--- a/plugins/org.eclipse.emf.compare.doc/pom.xml
+++ b/plugins/org.eclipse.emf.compare.doc/pom.xml
@@ -23,7 +23,35 @@
<artifactId>org.eclipse.emf.compare.doc</artifactId>
<version>3.1.0-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
-
+
+ <properties>
+ <simrel>luna</simrel>
+ <platform-isv>org.eclipse.platform.doc.isv/reference/api</platform-isv>
+ <javadoc-args>
+ -quiet
+ -breakiterator
+ -use
+ -splitIndex
+ -windowtitle "EMF Compare API Specification"
+ -doctitle "EMF Compare API Specification"
+ -header "&lt;span style='font-size:small'&gt;&lt;b&gt;EMF Compare&lt;/b&gt;&lt;br&gt;${unqualifiedVersion}.${buildQualifier}&lt;/span&gt;"
+ -bottom "&lt;br&gt;&lt;span style='font-size:small;float:right'&gt;Copyright (c) 2006, 2014 Obeo and others. All rights reserved.&lt;/span&gt;"
+ -tag 'noimplement:a:Restriction:'
+ -tag 'noextend:a:Restriction:'
+ -tag 'noreference:a:Restriction:'
+ -tag 'noinstantiate:a:Restriction:'
+ -tag 'nooverride:a:Restriction:'
+ -tag 'category:a:Category:'
+ -tag 'generated:a:Generated:'
+ -tag 'model:X'
+ -tag 'ordered:X'
+ -link http://download.oracle.com/javase/8/docs/api/
+ -link http://www.osgi.org/javadoc/r5/core/
+ -link http://www.osgi.org/javadoc/r5/enterprise/
+ -link http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/
+ </javadoc-args>
+ </properties>
+
<build>
<plugins>
<plugin>
@@ -75,7 +103,11 @@
<argument>-location</argument>
<argument>${project.basedir}</argument>
<argument>-eclipsehelp</argument>
+ <argument>${project.basedir}/help</argument>
<argument>-website</argument>
+ <argument>${project.build.directory}/website</argument>
+ <argument>-version</argument>
+ <argument>${unqualifiedVersion}.${buildQualifier}</argument>
</arguments>
</configuration>
</execution>
@@ -83,4 +115,61 @@
</plugin>
</plugins>
</build>
+ <profiles>
+ <profile>
+ <!--
+ Do the javadoc generation in a profile to keep standard builds (e.g. gerrit) fast.
+ -->
+ <id>javadoc</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.eclipse.tycho.extras</groupId>
+ <artifactId>tycho-document-bundle-plugin</artifactId>
+ <version>${tycho-version}</version>
+ <executions>
+ <execution>
+ <id>eclipse-javadoc</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>javadoc</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.basedir}/help/developer/javadoc</outputDirectory>
+ <tocFile>${project.basedir}/help/developer/toc-javadoc.xml</tocFile>
+ <javadocOptions>
+ <additionalArguments>
+ <additionalArgument>${javadoc-args}</additionalArgument>
+ <additionalArgument>
+ -linkoffline ./../../../${platform-isv} http://help.eclipse.org/${simrel}/topic/${platform-isv}
+ </additionalArgument>
+ </additionalArguments>
+ </javadocOptions>
+ </configuration>
+ </execution>
+ <execution>
+ <id>website-javadoc</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>javadoc</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${project.build.directory}/website/developer/javadoc</outputDirectory>
+ <tocFile>${project.build.directory}/toc-javadoc.xml</tocFile>
+ <javadocOptions>
+ <additionalArguments>
+ <additionalArgument>${javadoc-args}</additionalArgument>
+ <additionalArgument>
+ -link http://help.eclipse.org/${simrel}/topic/${platform-isv}
+ </additionalArgument>
+ </additionalArguments>
+ </javadocOptions>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
</project>
diff --git a/plugins/org.eclipse.emf.compare.doc/src/developer/~javadoc.mediawiki b/plugins/org.eclipse.emf.compare.doc/src/developer/~javadoc.mediawiki
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/plugins/org.eclipse.emf.compare.doc/src/developer/~javadoc.mediawiki
diff --git a/plugins/org.eclipse.emf.compare.doc/src/index.mediawiki b/plugins/org.eclipse.emf.compare.doc/src/index.mediawiki
index be1f5aa97..9b38ca035 100644
--- a/plugins/org.eclipse.emf.compare.doc/src/index.mediawiki
+++ b/plugins/org.eclipse.emf.compare.doc/src/index.mediawiki
@@ -1,20 +1,21 @@
-= Documentation =
-
-== User documentation ==
-
-* [user/user-guide.html|User guide]
-* [user/sample-use-case.html|Sample use case]
-
-== Developer documentation ==
-
-* [developer/developer-guide.html|Developer guide]
-* [developer/logical-model.html|Logical model]
-* [developer/how-to-open-compare-dialog.html|How to open compare dialog]
-
-== Tutorial ==
-
-* [tutorial/tutorial.html|Tutorial]
-
-== FAQ ==
-
+= Documentation =
+
+== User documentation ==
+
+* [user/user-guide.html|User guide]
+* [user/sample-use-case.html|Sample use case]
+
+== Developer documentation ==
+
+* [developer/developer-guide.html|Developer guide]
+* [developer/logical-model.html|Logical model]
+* [developer/how-to-open-compare-dialog.html|How to open compare dialog]
+* [developer/javadoc/index.html|API reference (Javadoc)]
+
+== Tutorial ==
+
+* [tutorial/tutorial.html|Tutorial]
+
+== FAQ ==
+
* [FAQ.html|FAQ] \ No newline at end of file
diff --git a/plugins/org.eclipse.emf.compare.doc/src/tutorial/tutorial.mediawiki b/plugins/org.eclipse.emf.compare.doc/src/tutorial/tutorial.mediawiki
index 52750e652..6f32e7d17 100644
--- a/plugins/org.eclipse.emf.compare.doc/src/tutorial/tutorial.mediawiki
+++ b/plugins/org.eclipse.emf.compare.doc/src/tutorial/tutorial.mediawiki
@@ -593,7 +593,6 @@ The first thing to understand is that this comparison is a 3-way comparison. Thi
Both scenario 1 and 2 used the master branch as starting point. This is why it has being used as common ancestor. We will see later on this tutorial how EMF Compare uses this third input. You can display its content in the user interface by clicking on "Show ancestor button" ([[Image:../images/EMF_Compare_Tuto_Show_Ancestor_Button.png]]).
-<div id="EMF_Compare_Tuto_Scenario2_Common_Ancestor_Img"></div>
[[Image:../images/EMF_Compare_Tuto_Scenario2_Common_Ancestor2.png | Common Ancestor 2]]
* Let's have a look on the differences.
@@ -615,7 +614,7 @@ You can notice that there is nothing highlighted in red. It seems that rejecting
* Reject the difference named "375 <nowiki>[page changed]</nowiki>".
[[Image:../images/EMF_Compare_Tuto_Scenario2_Reject_375.png]]
-In this case it has only rejected the current difference. If you look at the value of the attribute you will see that the number of page has been set to 100. This value is the value of the same attribute in the common ancestor model (see [[#EMF_Compare_Tuto_Scenario2_Common_Ancestor_Img | Common ancestor model]]). In 3-way comparison you can either accept the version of an attribute from one of the two input version (Scenario 1 or Scenario 2) or return the version to its common ancestor value (master).
+In this case it has only rejected the current difference. If you look at the value of the attribute you will see that the number of page has been set to 100. This value is the value of the same attribute in the common ancestor model (see picture "Common Ancestor 2"). In 3-way comparison you can either accept the version of an attribute from one of the two input version (Scenario 1 or Scenario 2) or return the version to its common ancestor value (master).
Obviously you can do the same actions on the difference named "374 <nowiki>[page changed]</nowiki>". It will:
* Set the value of the attribute to 374 and reject the other difference if you accept it.

Back to the top