Skip to content

Commit

Permalink
docs: generate javadoc with JDK 10 & fix lint issues
Browse files Browse the repository at this point in the history
- Dropped ExcludeDoclet
- Dropped custom javadoc CSS
- Dropped empty @param lines
- Updated field deduplication to the new JDK 10 javadoc layout
- Fixed characters that must be replaced with HTML escape sequences
- Fixed pre/code nesting (reverts ec09a19)
- Moved reference page links to the end (in a @see), so that method
  summaries are more interesting
  • Loading branch information
Spasi committed Jun 3, 2018
1 parent f2a677a commit 0d7917d
Show file tree
Hide file tree
Showing 1,343 changed files with 11,732 additions and 16,082 deletions.
24 changes: 9 additions & 15 deletions build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@

<!-- Includes all modules for javadoc.lwjgl.org -->
<target name="javadoc" description="Generates the LWJGL JavaDoc" depends="-compile-generator,-build-version">
<echo message="It is recommended to generate JavaDoc on JDK 9 or higher." unless:set="jdk9" taskname="Warning"/>
<echo message="It is recommended to generate JavaDoc on JDK 10 or higher." unless:set="jdk10" taskname="Warning"/>
<delete dir="bin/javadoc"/>

<path id="javadoc.sources">
Expand All @@ -689,7 +689,7 @@
<javadoc
destdir="bin/javadoc"
sourcepathref="javadoc.sources"
source="1.8"
source="9"
windowtitle="LWJGL ${build.version}"
encoding="UTF-8"
docencoding="UTF-8"
Expand All @@ -699,8 +699,6 @@
notree="true"
public="true"
Splitindex="true"
doclet="org.lwjgl.system.ExcludeDoclet"
docletpath="${bin.generator}"
maxmemory="1G"
failonerror="true"
>
Expand All @@ -713,10 +711,9 @@

<arg value="-XDignore.symbol.file=true"/> <!-- Supresses internal API (e.g. Unsafe) usage warnings -->

<arg value="-Xdoclint"/>
<arg line="-Xmaxwarns 1000"/>
<arg line="-Xdoclint:html,reference,syntax"/>
<arg line="-Xmaxerrs 1000 -Xmaxwarns 1000"/>
<arg value="-html5" if:set="jdk9"/>
<arg value="-stylesheetfile ${config}/javadoc.css" if:set="jdk9"/>
<arg line="-J-Dfile.encoding=UTF8"/>
<arg line="--add-exports jdk.javadoc/com.sun.tools.doclets=ALL-UNNAMED" if:set="jdk9"/>
</javadoc>
Expand Down Expand Up @@ -923,7 +920,7 @@
<mkdir dir="${release}/${module}/javadoc"/>
<javadoc
destdir="${release}/${module}/javadoc"
source="1.8"
source="9"
windowtitle="LWJGL ${build.version} - @{title}"
encoding="UTF-8"
docencoding="UTF-8"
Expand All @@ -932,8 +929,6 @@
nohelp="true"
notree="true"
public="true"
doclet="org.lwjgl.system.ExcludeDoclet"
docletpath="${bin.generator}"
failonerror="true"
>
<doctitle><![CDATA[<h1>LWJGL - @{title}</h1>]]></doctitle>
Expand All @@ -949,10 +944,9 @@

<arg value="-XDignore.symbol.file=true"/> <!-- Supresses internal API (e.g. Unsafe) usage warnings -->

<arg value="-Xdoclint:none"/>
<arg line="-Xmaxwarns 1"/>
<arg line="-Xdoclint:html,reference,syntax"/>
<arg line="-Xmaxerrs 1000 -Xmaxwarns 1000"/>
<arg value="-html5" if:set="jdk9"/>
<arg value="-stylesheetfile ${config}/javadoc.css" if:set="jdk9"/>
<arg line="-J-Dfile.encoding=UTF8"/>
<arg line="--add-exports jdk.javadoc/com.sun.tools.doclets=ALL-UNNAMED" if:set="jdk9"/>
</javadoc>
Expand Down Expand Up @@ -995,11 +989,11 @@

<local name="input"/>
<input
message="It is recommended to build LWJGL releases on JDK 9 or higher. Continue with JDK 8?"
message="It is recommended to build LWJGL releases on JDK 10 or higher. Continue with current JDK?"
validargs="y,n"
defaultvalue="n"
addproperty="input"
unless:set="jdk9"
unless:set="jdk10"
/>
<fail message="Cancelled" unless:set="jdk9">
<condition>
Expand Down
10 changes: 8 additions & 2 deletions config/build-definitions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,19 @@ This script is included in /build.xml and /config/update-dependencies.xml.
<property name="platform.remote" value="${platform}"/>

<!-- JDK version -->
<condition property="jdk9">
<condition property="jdk10"> <!-- 10 or higher -->
<!--
VNUM = [1-9][0-9]*((\.0)*\.[1-9][0-9]*)*
PRE = [a-zA-Z0-9]+
java.version = $VNUM(\-$PRE)?
-->
<matches string="${java.version}" pattern="^(9|[1-9][0-9]+)((\.0)*\.[1-9][0-9]*)*(-[a-zA-Z0-9]+)?$"/>
<matches string="${java.version}" pattern="^[1-9][0-9]+((\.0)*\.[1-9][0-9]*)*(-[a-zA-Z0-9]+)?$"/>
</condition>
<condition property="jdk9"> <!-- 9 or higher -->
<or>
<isset property="jdk10"/>
<matches string="${java.version}" pattern="^9((\.0)*\.[1-9][0-9]*)*(-[a-zA-Z0-9]+)?$"/>
</or>
</condition>
<property name="jni.headers" location="${java.home}/include" if:set="jdk9"/>
<property name="jni.headers" location="${java.home}/../include" unless:set="jdk9"/>
Expand Down
Loading

0 comments on commit 0d7917d

Please sign in to comment.