From 25e8fc02af9b8004de424586cf218cb8d76e1c5d Mon Sep 17 00:00:00 2001
From: Alexander Kurtakov <akurtako@redhat.com>
Date: Tue, 4 Feb 2020 17:31:05 +0200
Subject: [PATCH] Bug 559800 - Content in cdt.doc.isv badly outdated and broken

Redo the javadoc build process to be based on
tycho-document-bundle-plugin.
It has the nice effect of whole api from cdt.core being in the built
javadoc instead of the very few preselected bundles.

Change-Id: I3fd33daaef2ef3bcbbc7ee7dabfe6a7262b7a87e
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
---
 doc/org.eclipse.cdt.doc.isv/build.properties  |   2 +-
 doc/org.eclipse.cdt.doc.isv/buildDoc.xml      |  33 ----
 doc/org.eclipse.cdt.doc.isv/cdtOptions        |  36 ----
 doc/org.eclipse.cdt.doc.isv/cdtOptions.txt    |  36 ----
 .../customBuildCallbacks.xml                  | 159 ------------------
 doc/org.eclipse.cdt.doc.isv/pom.xml           |  65 +++----
 6 files changed, 35 insertions(+), 296 deletions(-)
 delete mode 100644 doc/org.eclipse.cdt.doc.isv/cdtOptions
 delete mode 100644 doc/org.eclipse.cdt.doc.isv/cdtOptions.txt
 delete mode 100644 doc/org.eclipse.cdt.doc.isv/customBuildCallbacks.xml

diff --git a/doc/org.eclipse.cdt.doc.isv/build.properties b/doc/org.eclipse.cdt.doc.isv/build.properties
index bb9e0ae8637..994928090a2 100644
--- a/doc/org.eclipse.cdt.doc.isv/build.properties
+++ b/doc/org.eclipse.cdt.doc.isv/build.properties
@@ -25,5 +25,5 @@ bin.includes = META-INF/,\
                index/,\
                notices.html
 
-customBuildCallbacks = customBuildCallbacks.xml
 src.includes = about.html
+jars.extra.classpath = platform:/plugin/org.eclipse.cdt.core
diff --git a/doc/org.eclipse.cdt.doc.isv/buildDoc.xml b/doc/org.eclipse.cdt.doc.isv/buildDoc.xml
index 8073d15d8f8..e0733e861ed 100644
--- a/doc/org.eclipse.cdt.doc.isv/buildDoc.xml
+++ b/doc/org.eclipse.cdt.doc.isv/buildDoc.xml
@@ -3,7 +3,6 @@
 
 	<target name="all">
 		<antcall target="convertSchemaToHtml" />
-		<antcall target="generateJavadoc" />
 		<antcall target="build.index" />
 	</target>
 
@@ -24,36 +23,4 @@
 	    <record name="${basedir}/cdtconvert.txt" action="stop"/>
 	</target>
 	
-	<target name="getJavadocPath">
-		<available file="${java.home}/../bin/javadoc.exe" property="javadoc" value="${java.home}/../bin/javadoc.exe"/>
-		<available file="${java.home}/../bin/javadoc" property="javadoc" value="${java.home}/../bin/javadoc" />
-	</target>
-	
-	<target name="generateJavadoc" depends="getJavadocPath" if="javadoc">
-	
-		<condition property="optionsFile" value="cdtOptions">
-		      <os family="unix" />
-	    </condition>
-	    <condition property="optionsFile" value="cdtOptions.txt">
-		      <os family="windows" />
-	    </condition>
-	
-		<replace file="${basedir}/${optionsFile}" token="@rt@" value="${bootclasspath}" />
-	
-		<!--scrub isv plugin directories of any preexisting api doc content-->
-		<delete dir="reference/api"/>
-		<mkdir dir="reference/api"/>
-	
-		<exec dir="." executable="${javadoc}" output="doc.bin.log">
-			<arg line="@${basedir}/${optionsFile} -J-Xmx500M" />
-		</exec>
-	</target>
-	
-	<target name="createDocZip">
-		<zip zipfile="${basedir}/doc.zip"
-			basedir="${basedir}"
-			includes="book.css, cpy.gif, notices.html, about.html, no_help_exists.htm, concepts/**, gettingStarted/**, images/**, reference/**, tasks/**,samples/**,guide/**,questions/**"
-		/>
-	</target>
-
 </project>
diff --git a/doc/org.eclipse.cdt.doc.isv/cdtOptions b/doc/org.eclipse.cdt.doc.isv/cdtOptions
deleted file mode 100644
index 6461f24118e..00000000000
--- a/doc/org.eclipse.cdt.doc.isv/cdtOptions
+++ /dev/null
@@ -1,36 +0,0 @@
--charset "iso-8859-1"
--sourcepath "../../core/org.eclipse.cdt.core.native/src:../../core/org.eclipse.cdt.core/model:../../core/org.eclipse.cdt.core/parser"
--d reference/api
--classpath  ${bootclasspath}:../org.apache.ant/lib/ant.jar:../org.eclipse.debug.core/dtcore.jar:../org.eclipse.compare/compare.jar:../org.eclipse.help/help.jar:../org.eclipse.help.ui/helpworkbench.jar:../org.eclipse.core.resources_*.jar:../org.eclipse.core.runtime/runtime.jar:../org.eclipse.core.filebuffers/filebuffers.jar:../org.eclipse.core.expressions/expressions.jar:../org.eclipse.swt.win32/ws/win32/swt.jar:../org.eclipse.swt.motif/ws/motif/swt.jar:../org.eclipse.ui/ui.jar:../org.eclipse.jdt.debug/jdi.jar:../org.eclipse.debug.ui/dtui.jar:../org.eclipse.search/search.jar:../org.eclipse.jface/jface.jar:../org.eclipse.jface.text/jfacetext.jar:../org.eclipse.text/text.jar:../org.eclipse.ui.editors/editors.jar:../org.eclipse.ui.views/views.jar:../org.eclipse.ui.workbench/workbench.jar:../org.eclipse.ui.workbench.texteditor/texteditor.jar:../org.eclipse.core.variables/variables.jar:../org.eclipse.ui.ide/ide.jar:../org.eclipse.jdt.junit/junitsupport.jar:../org.eclipse.osgi/osgi.jar:../org.eclipse.osgi/core.jar:../org.eclipse.osgi/eclipseAdaptor.jar:../org.eclipse.osgi.services/services.jar:../org.eclipse.osgi.util/util.jar
--breakiterator
--use
--splitIndex
--windowtitle "Eclipse CDT API Specification"
--doctitle "Eclipse CDT API Specification"
--header "<strong>Eclipse CDT</strong><br>9.11.0"
--bottom "Copyright (c) IBM Corp. and others 2004, 2020.  All Rights Reserved."
--group "C/C++ Development Tools Core Plug-in Packages" "org.eclipse.cdt.core:org.eclipse.cdt.core.*"
--group "C/C++ Development Tools Debug Core Plug-in Packages" "org.eclipse.cdt.debug.core:org.eclipse.cdt.debug.core.*"
--link https://docs.oracle.com/en/java/javase/11/docs/api/
--tag 'noimplement:a:Restriction:'
--tag 'noextend:a:Restriction:'
--tag 'noreference:a:Restriction:'
--tag 'noinstantiate:a:Restriction:'
--tag 'nooverride:a:Restriction:'
--tag 'TrackedGetter:cm:"TrackedGetter"'
--tag 'model:X:"EMF generated tag"'
--tag 'generated:X:"EMF generated tag"'
--tag 'ordered:X:"EMF generated tag"'
--tag 'Immutable:t'
--tag 'implNote:a:<em>Implementation Note:</em>'
-
-org.eclipse.cdt.core
-org.eclipse.cdt.core.model
-org.eclipse.cdt.core.dom.ast
-org.eclipse.cdt.core.dom.ast.c
-org.eclipse.cdt.core.dom.ast.cpp
-org.eclipse.cdt.core.dom.ast.gnu
-org.eclipse.cdt.core.dom.ast.gnu.c
-org.eclipse.cdt.core.dom.ast.gnu.cpp
-org.eclipse.cdt.utils.pty
-org.eclipse.cdt.utils.spawner
diff --git a/doc/org.eclipse.cdt.doc.isv/cdtOptions.txt b/doc/org.eclipse.cdt.doc.isv/cdtOptions.txt
deleted file mode 100644
index e3420391e7d..00000000000
--- a/doc/org.eclipse.cdt.doc.isv/cdtOptions.txt
+++ /dev/null
@@ -1,36 +0,0 @@
--charset "iso-8859-1"
--sourcepath "../../core/org.eclipse.cdt.core.native/src;../../core/org.eclipse.cdt.core/model;../../core/org.eclipse.cdt.core/parser"
--d reference/api
--classpath  ${bootclasspath};../org.apache.ant/lib/ant.jar;../org.eclipse.debug.core/dtcore.jar;../org.eclipse.compare/compare.jar;../org.eclipse.help/help.jar;../org.eclipse.help.ui/helpworkbench.jar;../org.eclipse.core.resources_*.jar;../org.eclipse.core.runtime/runtime.jar;../org.eclipse.core.filebuffers/filebuffers.jar;../org.eclipse.core.expressions/expressions.jar;../org.eclipse.swt.win32/ws/win32/swt.jar;../org.eclipse.swt.motif/ws/motif/swt.jar;../org.eclipse.ui/ui.jar;../org.eclipse.jdt.debug/jdi.jar;../org.eclipse.debug.ui/dtui.jar;../org.eclipse.search/search.jar;../org.eclipse.jface/jface.jar;../org.eclipse.jface.text/jfacetext.jar;../org.eclipse.text/text.jar;../org.eclipse.ui.editors/editors.jar;../org.eclipse.ui.views/views.jar;../org.eclipse.ui.workbench/workbench.jar;../org.eclipse.ui.workbench.texteditor/texteditor.jar;../org.eclipse.core.variables/variables.jar;../org.eclipse.ui.ide/ide.jar;../org.eclipse.jdt.junit/junitsupport.jar;../org.eclipse.osgi/osgi.jar;../org.eclipse.osgi/core.jar;../org.eclipse.osgi/eclipseAdaptor.jar;../org.eclipse.osgi.services/services.jar;../org.eclipse.osgi.util/util.jar
--breakiterator
--use
--splitIndex
--windowtitle "Eclipse CDT API Specification"
--doctitle "Eclipse CDT API Specification"
--header "<strong>Eclipse CDT</strong><br>9.11.0"
--bottom "Copyright (c) IBM Corp. and others 2004, 2020.  All Rights Reserved."
--group "C/C++ Development Tools Core Plug-in Packages" "org.eclipse.cdt.core;org.eclipse.cdt.core.*"
--group "C/C++ Development Tools Debug Core Plug-in Packages" "org.eclipse.cdt.debug.core;org.eclipse.cdt.debug.core.*"
--link https://docs.oracle.com/en/java/javase/11/docs/api/
--tag 'noimplement:a:Restriction:'
--tag 'noextend:a:Restriction:'
--tag 'noreference:a:Restriction:'
--tag 'noinstantiate:a:Restriction:'
--tag 'nooverride:a:Restriction:'
--tag 'TrackedGetter:cm:"TrackedGetter"'
--tag 'model:X:"EMF generated tag"'
--tag 'generated:X:"EMF generated tag"'
--tag 'ordered:X:"EMF generated tag"'
--tag 'Immutable:t'
--tag 'implNote:a:<em>Implementation Note:</em>'
-
-org.eclipse.cdt.core
-org.eclipse.cdt.core.model
-org.eclipse.cdt.core.dom.ast
-org.eclipse.cdt.core.dom.ast.c
-org.eclipse.cdt.core.dom.ast.cpp
-org.eclipse.cdt.core.dom.ast.gnu
-org.eclipse.cdt.core.dom.ast.gnu.c
-org.eclipse.cdt.core.dom.ast.gnu.cpp
-org.eclipse.cdt.utils.pty
-org.eclipse.cdt.utils.spawner
diff --git a/doc/org.eclipse.cdt.doc.isv/customBuildCallbacks.xml b/doc/org.eclipse.cdt.doc.isv/customBuildCallbacks.xml
deleted file mode 100644
index 2aed4949403..00000000000
--- a/doc/org.eclipse.cdt.doc.isv/customBuildCallbacks.xml
+++ /dev/null
@@ -1,159 +0,0 @@
-<!-- ===================================================================== -->
-<!-- Custom targets called from a project's generated build.xml            -->
-<!-- Set customBuildCallbacks=<path/to/this/file> in your build.properties.-->
-<!-- ===================================================================== -->
-<project name="Build specific targets and properties" default="noDefault">
-
-	<!-- ===================================================================== -->
-	<!-- Default target                                                        -->
-	<!-- ===================================================================== -->
-	<target name="noDefault">
-		<echo message="This file must be called with explicit targets" />
-	</target>
-	
-	<!-- ===================================================================== -->
-	<!-- Steps to do before the target build.jars                              -->
-	<!-- Available parameters :                                                -->
-	<!--   build.result.folder - folder to contain the build results           -->
-	<!-- ===================================================================== -->
-	<target name="pre.build.jars">
-		<ant antfile="buildDoc.xml"/>
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do after the target build.jars                               -->
-	<!-- Available parameters :                                                -->
-	<!--   build.result.folder - folder to contain the build results           -->
-	<!-- ===================================================================== -->
-	<target name="post.build.jars">
-	</target>
-	
-	<!-- ===================================================================== -->
-	<!-- Steps to do before the target build.sources                           -->
-	<!-- Available parameters :                                                -->
-	<!--   build.result.folder - folder to contain the build results           -->
-	<!-- ===================================================================== -->
-	<target name="pre.build.sources">
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do after the target build.sources                            -->
-	<!-- Available parameters :                                                -->
-	<!--   build.result.folder - folder to contain the build results           -->
-	<!-- ===================================================================== -->
-	<target name="post.build.sources">
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do before the compilation target <name>                      -->
-	<!-- Substitute "name" with the name of the compilation target, eg @dot    -->
-	<!-- Available parameters :                                                -->
-	<!--   source.foldern : n = 1 ... N, the source folders                    -->
-	<!--   target.folder  : where the results of the compilation go            -->
-	<!--   <name>.classpath : name = name of the compilation target. A         -->
-	<!--                      reference to the classpath structure.            -->
-	<!-- ===================================================================== -->
-	<target name="pre.name">
-	</target>
-
-	<target name="pre.@dot">
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do during the compilation target <name>, after the compile   -->
-	<!-- but before jaring.  Substitute "name" with the name of the compilation-->
-	<!-- target, eg @dot                                                       -->
-	<!-- Available parameters :                                                -->
-	<!--   source.foldern : n = 1 ... N, the source folders                    -->
-	<!--   target.folder  : where the results of the compilation go            -->
-	<!--   <name>.classpath : name = name of the compilation target. A         -->
-	<!--                      reference to the classpath structure.            -->
-	<!-- ===================================================================== -->
-	<target name="post.compile.name">
-	</target>
-
-	<target name="post.compile.@dot">
-	</target>
-	
-	<!-- ===================================================================== -->
-	<!-- Steps to do after the compilation target <name>                       -->
-	<!-- Substitute "name" with the name of the compilation target, eg @dot    -->
-	<!-- Available parameters :                                                -->
-	<!--   jar.location - the location of the compilation results              -->
-	<!--   <name>.classpath : name = name of the compilation target. A         -->
-	<!--                      reference to the classpath structure.            -->
-	<!-- ===================================================================== -->
-	<target name="post.name">
-	</target>
-
-	<target name="post.@dot">
-	</target>
-	
-	<!-- ===================================================================== -->
-	<!-- Steps to do before the target gather.bin.parts                         -->
-	<!-- Available parameters :                                                -->
-	<!--   build.result.folder - folder containing the build results           -->
-	<!--   target.folder - destination folder                                  -->
-	<!-- ===================================================================== -->
-	<target name="pre.gather.bin.parts">
-	</target>
-		
-	<!-- ===================================================================== -->
-	<!-- Steps to do after the target gather.bin.parts                         -->
-	<!-- Available parameters :                                                -->
-	<!--   build.result.folder - folder containing the build results           -->
-	<!--   target.folder - destination folder                                  -->
-	<!-- ===================================================================== -->
-	<target name="post.gather.bin.parts">
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do before the target gather.sources                          -->
-	<!-- Available parameters :                                                -->
-	<!--   destination.temp.folder - destination folder                        -->
-	<!-- ===================================================================== -->
-	<target name="pre.gather.sources">
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do after the target gather.sources                           -->
-	<!-- Available parameters :                                                -->
-	<!--   destination.temp.folder - destination folder                        -->
-	<!-- ===================================================================== -->
-	<target name="post.gather.sources">
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do before the target gather.logs                             -->
-	<!-- Available parameters :                                                -->
-	<!--   destination.temp.folder - destination folder                        -->
-	<!-- ===================================================================== -->
-	<target name="pre.gather.logs">        
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do after the target gather.logs                              -->
-	<!-- Available parameters :                                                -->
-	<!--   destination.temp.folder - destination folder                        -->
-	<!-- ===================================================================== -->
-	<target name="post.gather.logs">       
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do before the target clean                                   -->
-	<!-- Available parameters :                                                -->
-	<!--   destination.temp.folder - destination folder                        -->
-	<!-- ===================================================================== -->
-	<target name="pre.clean">              
-	</target>
-
-	<!-- ===================================================================== -->
-	<!-- Steps to do after the target clean                                    -->
-	<!-- Available parameters :                                                -->
-	<!--   plugin.destination - final destination of the build                 -->
-	<!--   build.result.folder - results of the compilation                    -->
-	<!--   temp.folder - temporary folder                                      -->
-	<!-- ===================================================================== -->
-	<target name="post.clean">             
-	</target>
-</project>
diff --git a/doc/org.eclipse.cdt.doc.isv/pom.xml b/doc/org.eclipse.cdt.doc.isv/pom.xml
index ee341f79873..a1fd8e95bbf 100644
--- a/doc/org.eclipse.cdt.doc.isv/pom.xml
+++ b/doc/org.eclipse.cdt.doc.isv/pom.xml
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
@@ -46,39 +47,41 @@
 				<plugins>
 					<plugin>
 						<groupId>org.eclipse.tycho.extras</groupId>
-						<artifactId>tycho-eclipserun-plugin</artifactId>
-						<version>${tycho-extras-version}</version>
-						<configuration>
-							<appArgLine>-application org.eclipse.ant.core.antRunner -buildfile buildDoc.xml</appArgLine>
-							<dependencies>
-								<dependency>
-									<artifactId>org.apache.ant</artifactId>
-									<type>eclipse-plugin</type>
-								</dependency>
-								<dependency>
-									<artifactId>org.eclipse.help.base</artifactId>
-									<type>eclipse-plugin</type>
-								</dependency>
-								<dependency>
-									<artifactId>org.eclipse.pde.core</artifactId>
-									<type>eclipse-plugin</type>
-								</dependency>
-								<dependency>
-									<artifactId>javax.annotation</artifactId>
-									<type>eclipse-plugin</type>
-								</dependency>
-								<dependency>
-									<artifactId>org.eclipse.osgi.compatibility.state</artifactId>
-									<type>eclipse-plugin</type>
-								</dependency>
-							</dependencies>
-						</configuration>
+						<artifactId>tycho-document-bundle-plugin</artifactId>
+						<version>${tycho-version}</version>
 						<executions>
 							<execution>
+								<id>eclipse-javadoc</id>
+								<phase>generate-resources</phase>
 								<goals>
-									<goal>eclipse-run</goal>
+									<goal>javadoc</goal>
 								</goals>
-								<phase>compile</phase>
+								<configuration>
+									<outputDirectory>${project.basedir}/reference/api
+									</outputDirectory>
+									<javadocOptions>
+										<excludes>
+											<exclude>org.eclipse.cdt.internal.*</exclude>
+										</excludes>
+										<additionalArguments>
+											<additionalArgument>-windowtitle "Eclipse CDT API Specification"</additionalArgument>
+											<additionalArgument>-doctitle "Eclipse CDT API Specification"
+											</additionalArgument>
+											<additionalArgument>-link "https://docs.oracle.com/javase/8/docs/api/"</additionalArgument>
+											<additionalArgument>-linkoffline ../../org.eclipse.platform.doc.isv/reference/api
+											</additionalArgument>
+											<additionalArgument>-public</additionalArgument>
+											<additionalArgument>-header "Eclipse CDT 9.11.0"
+											</additionalArgument>
+											<additionalArgument>-bottom "Copyright (c) IBM Corp. and others 2004, 2020. All Rights Reserved."</additionalArgument>
+											<additionalArgument>-tag 'noimplement:a:Restriction:'</additionalArgument>
+											<additionalArgument>-tag 'noextend:a:Restriction:'</additionalArgument>
+											<additionalArgument>-tag 'noreference:a:Restriction:'</additionalArgument>
+											<additionalArgument>-tag 'noinstantiate:a:Restriction:'</additionalArgument>
+											<additionalArgument>-tag 'nooverride:a:Restriction:'</additionalArgument>
+										</additionalArguments>
+									</javadocOptions>
+								</configuration>
 							</execution>
 						</executions>
 					</plugin>
@@ -102,7 +105,7 @@
 								<phase>compile</phase>
 								<configuration>
 									<target>
-										<touch file="index/indexed_docs" mkdirs="true"/>
+										<touch file="index/indexed_docs" mkdirs="true" />
 									</target>
 								</configuration>
 								<goals>