diff options
author | Mikaël Barbero | 2014-07-25 14:59:55 +0000 |
---|---|---|
committer | Mikaël Barbero | 2014-07-25 15:12:18 +0000 |
commit | cfc11e371cf521d7f504e59e87b0faf1fddd942f (patch) | |
tree | 32838a6aafb049b3c38b25f1296b564979997839 /packaging | |
parent | 998abd016f179ba509bfcc3ddd20b9a8f12c7fd1 (diff) | |
download | org.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
Diffstat (limited to 'packaging')
7 files changed, 63 insertions, 64 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 Binary files differdeleted 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 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 Binary files differdeleted 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 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); |