Skip to content

Commit 8a54f44

Browse files
committed
Javadoc updates for DTFJ & management extensions
* add HTML overview files for Java 8 * add javadoc to module-info.java files * add missing package-info.java files * apply accessibility fix (better colour contrast) * remove redundant tooling for Java 9 javadoc generation * use unix line-ends Signed-off-by: Keith W. Campbell <[email protected]>
1 parent 86ee9d5 commit 8a54f44

16 files changed

+428
-310
lines changed

jcl/com.ibm.dtfj-javadoc-829.launch

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<?xml version="1.0" encoding="UTF-8"?><launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
2-
<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
3-
<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#13;&#10;&lt;resources&gt;&#13;&#10;&lt;item path=&quot;/pConfig SIDECAR18-DTFJ&quot; type=&quot;4&quot;/&gt;&#13;&#10;&lt;/resources&gt;}"/>
4-
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
5-
<listEntry value="/jcl/com.ibm.lang.management-javadoc-829.xml"/>
6-
</listAttribute>
7-
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
8-
<listEntry value="1"/>
9-
</listAttribute>
10-
<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
11-
<stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
12-
<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/>
13-
<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="jcl"/>
14-
<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
15-
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LAUNCH_CONFIGURATION_BUILD_SCOPE" value="${none}"/>
16-
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/jcl/com.ibm.lang.management-javadoc-829.xml}"/>
17-
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/pConfig SIDECAR18-SE}"/>
18-
<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
1+
<?xml version="1.0" encoding="UTF-8"?><launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
2+
<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
3+
<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#10;&lt;resources&gt;&#10;&lt;item path=&quot;/pConfig SIDECAR18-DTFJ&quot; type=&quot;4&quot;/&gt;&#10;&lt;/resources&gt;}"/>
4+
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
5+
<listEntry value="/jcl/com.ibm.dtfj-javadoc-829.xml"/>
6+
</listAttribute>
7+
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
8+
<listEntry value="1"/>
9+
</listAttribute>
10+
<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
11+
<stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
12+
<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/>
13+
<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="jcl"/>
14+
<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
15+
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LAUNCH_CONFIGURATION_BUILD_SCOPE" value="${none}"/>
16+
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/jcl/com.ibm.dtfj-javadoc-829.xml}"/>
17+
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/pConfig SIDECAR18-DTFJ}"/>
18+
<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
1919
</launchConfiguration>

jcl/com.ibm.dtfj-javadoc-829.xml

+87-80
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,87 @@
1-
<!--
2-
/*******************************************************************************
3-
* Copyright (c) 2016, 2017 IBM Corp. and others
4-
*
5-
* This program and the accompanying materials are made available under
6-
* the terms of the Eclipse Public License 2.0 which accompanies this
7-
* distribution and is available at https://www.eclipse.org/legal/epl-2.0/
8-
* or the Apache License, Version 2.0 which accompanies this distribution and
9-
* is available at https://www.apache.org/licenses/LICENSE-2.0.
10-
*
11-
* This Source Code may also be made available under the following
12-
* Secondary Licenses when the conditions for such availability set
13-
* forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
14-
* General Public License, version 2 with the GNU Classpath
15-
* Exception [1] and GNU General Public License, version 2 with the
16-
* OpenJDK Assembly Exception [2].
17-
*
18-
* [1] https://www.gnu.org/software/classpath/license.html
19-
* [2] http://openjdk.java.net/legal/assembly-exception.html
20-
*
21-
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
22-
*******************************************************************************/
23-
-->
24-
25-
<project default="javadoc" basedir=".">
26-
<target name="setup">
27-
<property name="javadoc.dir" location="com.ibm.dtfj-javadoc" />
28-
<echo>javadoc.exe=${javadoc.exe}</echo>
29-
<pathconvert property="src.path">
30-
<path location="src" />
31-
</pathconvert>
32-
<tstamp>
33-
<format property="year" pattern="yyyy" />
34-
</tstamp>
35-
<property name="bottom" value="&amp;copy; Copyright (c) 2004, ${year} IBM Corp. and others" />
36-
<property name="zip.dest.dir" location="../JavaID Development API docs/non-security/80_api/com.ibm.dtfj" />
37-
<condition property="zip.dest.exists">
38-
<available file="${zip.dest.dir}" />
39-
</condition>
40-
</target>
41-
42-
<target name="generate" depends="setup">
43-
<delete dir="${javadoc.dir}" />
44-
<mkdir dir="${javadoc.dir}" />
45-
<exec executable="${javadoc.exe}" dir="${javadoc.dir}" failonerror="true">
46-
<arg value="-verbose" />
47-
<arg value="-sourcepath" />
48-
<arg value="${src.path}" />
49-
<arg value="com.ibm.dtfj.image" />
50-
<arg value="com.ibm.dtfj.java" />
51-
<arg value="com.ibm.dtfj.runtime" />
52-
<arg value="-bottom" />
53-
<arg value="${bottom}" />
54-
</exec>
55-
56-
<!-- remove unwanted line in stylesheet.css: -->
57-
<!-- @import url('resources/fonts/dejavu.css'); -->
58-
<copy file="${javadoc.dir}/stylesheet.css" tofile="${javadoc.dir}/stylesheet.css.tmp">
59-
<filterchain>
60-
<linecontainsregexp negate="true">
61-
<regexp pattern="@import" />
62-
</linecontainsregexp>
63-
</filterchain>
64-
</copy>
65-
<move file="${javadoc.dir}/stylesheet.css.tmp" tofile="${javadoc.dir}/stylesheet.css" />
66-
</target>
67-
68-
<target name="update-zip" depends="generate" if="zip.dest.exists">
69-
<zip basedir="${javadoc.dir}" destfile="${zip.dest.dir}/com.ibm.dtfj.zip" />
70-
</target>
71-
72-
<target name="warn-no-update" depends="generate" unless="zip.dest.exists">
73-
<echo level="warning" message="Can't find '${zip.dest.dir}', so not updating com.ibm.dtfj.zip" />
74-
</target>
75-
76-
<target name="javadoc" depends="generate, update-zip, warn-no-update">
77-
<echo level="info" message="Done" />
78-
</target>
79-
80-
</project>
1+
<!--
2+
Copyright (c) 2016, 2017 IBM Corp. and others
3+
4+
This program and the accompanying materials are made available under
5+
the terms of the Eclipse Public License 2.0 which accompanies this
6+
distribution and is available at https://www.eclipse.org/legal/epl-2.0/
7+
or the Apache License, Version 2.0 which accompanies this distribution and
8+
is available at https://www.apache.org/licenses/LICENSE-2.0.
9+
10+
This Source Code may also be made available under the following
11+
Secondary Licenses when the conditions for such availability set
12+
forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
13+
General Public License, version 2 with the GNU Classpath
14+
Exception [1] and GNU General Public License, version 2 with the
15+
OpenJDK Assembly Exception [2].
16+
17+
[1] https://www.gnu.org/software/classpath/license.html
18+
[2] http://openjdk.java.net/legal/assembly-exception.html
19+
20+
SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
21+
-->
22+
<project default="javadoc" basedir=".">
23+
24+
<target name="setup">
25+
<property name="javadoc.dir" location="com.ibm.dtfj-javadoc" />
26+
<!-- set path for javadoc for linux from IBM Java8sr5 SDK -->
27+
<property name="javadoc.linux" location="/bluebird/vmlab.bluebird.bin/platform/linux386/6480sr5-20170206/sdk/bin/javadoc" />
28+
<property name="javadoc.windows" location="W:\bin\sdk6480sr5-20170206\bin\javadoc" />
29+
<condition property="javadoc.exe" value="${javadoc.windows}" else="${javadoc.linux}">
30+
<os family="windows" />
31+
</condition>
32+
<echo level="info" message="javadoc.exe=${javadoc.exe}" />
33+
<pathconvert property="src.path">
34+
<path location="src" />
35+
</pathconvert>
36+
<tstamp>
37+
<format property="year" pattern="yyyy" />
38+
</tstamp>
39+
<property name="bottom" value="&amp;copy; Copyright (c) 2004, ${year} IBM Corp. and others" />
40+
<property name="zip.dest.dir" location="../JavaID Development API docs/non-security/80_api/com.ibm.dtfj" />
41+
<condition property="zip.dest.exists">
42+
<available file="${zip.dest.dir}" />
43+
</condition>
44+
</target>
45+
46+
<target name="generate" depends="setup">
47+
<delete dir="${javadoc.dir}" />
48+
<mkdir dir="${javadoc.dir}" />
49+
<exec executable="${javadoc.exe}" dir="${javadoc.dir}" failonerror="true">
50+
<arg value="-sourcepath" />
51+
<arg value="${src.path}" />
52+
<arg value="com.ibm.dtfj.image" />
53+
<arg value="com.ibm.dtfj.java" />
54+
<arg value="com.ibm.dtfj.runtime" />
55+
<arg value="-bottom" />
56+
<arg value="${bottom}" />
57+
<arg value="-overview" />
58+
<arg value="${src.path}/dtfj-overview.html" />
59+
</exec>
60+
61+
<!-- remove unwanted line in stylesheet.css: -->
62+
<!-- @import url('resources/fonts/dejavu.css'); -->
63+
<copy file="${javadoc.dir}/stylesheet.css" tofile="${javadoc.dir}/stylesheet.css.tmp">
64+
<filterchain>
65+
<linecontainsregexp negate="true">
66+
<regexp pattern="@import" />
67+
</linecontainsregexp>
68+
</filterchain>
69+
</copy>
70+
<move file="${javadoc.dir}/stylesheet.css.tmp" tofile="${javadoc.dir}/stylesheet.css" />
71+
<!-- improve accessibility -->
72+
<echo message=".subNav ul.navList a, .subNav ul.subNavList a { color: #002d4a; }${line.separator}" file="${javadoc.dir}/stylesheet.css" append="true" />
73+
</target>
74+
75+
<target name="update-zip" depends="generate" if="zip.dest.exists">
76+
<zip basedir="${javadoc.dir}" destfile="${zip.dest.dir}/com.ibm.dtfj.zip" />
77+
</target>
78+
79+
<target name="warn-no-update" depends="generate" unless="zip.dest.exists">
80+
<echo level="warning" message="Can't find '${zip.dest.dir}', so not updating com.ibm.dtfj.zip" />
81+
</target>
82+
83+
<target name="javadoc" depends="update-zip, warn-no-update">
84+
<echo level="info" message="Done" />
85+
</target>
86+
87+
</project>
+18-18
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<?xml version="1.0" encoding="UTF-8"?><launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
2-
<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
3-
<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#13;&#10;&lt;resources&gt;&#13;&#10;&lt;item path=&quot;/pConfig SIDECAR18-SE&quot; type=&quot;4&quot;/&gt;&#13;&#10;&lt;/resources&gt;}"/>
4-
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
5-
<listEntry value="/jcl/com.ibm.lang.management-javadoc-829.xml"/>
6-
</listAttribute>
7-
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
8-
<listEntry value="1"/>
9-
</listAttribute>
10-
<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
11-
<stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
12-
<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/>
13-
<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="jcl"/>
14-
<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
15-
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LAUNCH_CONFIGURATION_BUILD_SCOPE" value="${none}"/>
16-
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/jcl/com.ibm.lang.management-javadoc-829.xml}"/>
17-
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/pConfig SIDECAR18-SE}"/>
18-
<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
1+
<?xml version="1.0" encoding="UTF-8"?><launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
2+
<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
3+
<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${working_set:&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#10;&lt;resources&gt;&#10;&lt;item path=&quot;/pConfig SIDECAR18-SE&quot; type=&quot;4&quot;/&gt;&#10;&lt;/resources&gt;}"/>
4+
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
5+
<listEntry value="/jcl/com.ibm.lang.management-javadoc-829.xml"/>
6+
</listAttribute>
7+
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
8+
<listEntry value="1"/>
9+
</listAttribute>
10+
<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
11+
<stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
12+
<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/>
13+
<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="jcl"/>
14+
<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
15+
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LAUNCH_CONFIGURATION_BUILD_SCOPE" value="${none}"/>
16+
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/jcl/com.ibm.lang.management-javadoc-829.xml}"/>
17+
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/pConfig SIDECAR18-SE}"/>
18+
<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
1919
</launchConfiguration>

0 commit comments

Comments
 (0)