Update javadoc and groovydoc scripts to version 2.6

Repast · Nov 15, 2018 · d40445f · d40445f
1 parent d1da443
commit d40445f
Show file tree

Hide file tree

Showing 5 changed files with 138 additions and 139 deletions.
diff --git a/repast.simphony.deployment/Generate javadoc Win.launch b/repast.simphony.deployment/Generate javadoc Win.launch
@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
-<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="true"/>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
-<listEntry value="/repast.simphony.deployment/javadoc.xml"/>
-</listAttribute>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
-<listEntry value="1"/>
-</listAttribute>
-<mapAttribute key="org.eclipse.debug.core.environmentVariables">
-<mapEntry key="ANT_HOME" value="C:\eclipse-committers-oxygen-1a-win32-x86_64\eclipse\plugins\org.apache.ant_1.10.1.v20170504-0840"/>
-<mapEntry key="path" value="C:\Program Files\Java\jdk1.8.0_152\bin"/>
-</mapAttribute>
-<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
-<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
-</listAttribute>
-<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jre1.8.0_152"/>
-<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/>
-<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="repast.simphony.deployment"/>
-<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/repast.simphony.deployment/javadoc.xml}"/>
-<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
+    <booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="true"/>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+        <listEntry value="/repast.simphony.deployment/javadoc.xml"/>
+    </listAttribute>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+        <listEntry value="1"/>
+    </listAttribute>
+    <mapAttribute key="org.eclipse.debug.core.environmentVariables">
+        <mapEntry key="path" value="jdk11/bin"/>
+    </mapAttribute>
+    <listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+        <listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+    </listAttribute>
+    <booleanAttribute key="org.eclipse.jdt.launching.ATTR_USE_CLASSPATH_ONLY_JAR" value="false"/>
+    <stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
+    <stringAttribute key="org.eclipse.jdt.launching.JRE_CONTAINER" value="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jdk11"/>
+    <stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="org.eclipse.ant.internal.launching.remote.InternalAntRunner"/>
+    <stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="repast.simphony.deployment"/>
+    <stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/repast.simphony.deployment/javadoc.xml}"/>
+    <stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
 </launchConfiguration>
diff --git a/repast.simphony.deployment/javadoc.xml b/repast.simphony.deployment/javadoc.xml
@@ -1,19 +1,39 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Build the Repast JavaDoc
 
-		 Working as of Releas 2.5 Oct 2017
+	Working as of Release 2.6 Nov 2018
 
-	Notes: * Groovy files will fail and should not be included
+	Notes: 	* Javadoc as of JDK 9 is a lot more sensitive to errors and options
+			  compared to JDK 8 and earlier, so pay attention to arguments.
 	
-				 * The useexternalfile=yes is needed on Windows in order to avoid a
+			* Groovy files will fail and should not be included
+	
+			* The useexternalfile=yes is needed on Windows in order to avoid a
 	         problem with long paths for the javadoc.exe
 	         
-	       * The fileset needs to explictely include Repast projects src folders
+	       	* The fileset needs to explictely include Repast projects src folders
 	         and source file types.  All others will be ignored.
 	         
-	       * It's normal and OK for lots of warnings to occur mostly due to poor
+	       	* It's normal and OK for lots of warnings to occur mostly due to poor
 	         javadoc formatting.  However any error in the "Loading Source" phase 
 	         is usually fatal if when the script reports BUILD SUCCESSFULL
+	         
+	        * nohelp option disables generation of javadoc help
+	        
+	        * noindex option disables generation of javadoc search.  Default is
+	          to generate the search which in turn creats lots of javascript
+	          files that may not work properly onine.
+	          
+	        * -frames options enables html frames which is now disabled by default
+	        
+	        * - -ignore-source-errors is needed otherwise javadoc will fail due
+	          to the numerous source warnings for things like groovy classes.
+	          
+	        * - -no-module-direcories is needed otherwise the search index will
+	          put in an /undefined/ module in the path, since we don't actually
+	          use modules in the project.
+	          
+	        * - -frames will generate frames (deprecated)
 -->
 
 
@@ -24,9 +44,12 @@
 			author="true" 
 			version="true" 
 			use="true" 
-			windowtitle="Repast Simphony 2.5 API" 
-			useexternalfile="yes">
-
+			windowtitle="Repast Simphony 2.6 API" 
+			useexternalfile="yes"
+			nohelp="false"
+			noindex="false"
+			additionalparam="--ignore-source-errors --no-module-directories" >
+
 			<fileset dir="../repast.simphony.batch/src" casesensitive="no">
 				<include name="**/*.java" />
 			</fileset>

diff --git a/repast.simphony.relogo.runtime/buildGroovyDocs.xml b/repast.simphony.relogo.runtime/buildGroovyDocs.xml
@@ -28,9 +28,7 @@
 					<pathelement path="../repast.simphony.visualization/src" />
 				</path>
 	<property name="sp" refid="sourcePath"/>
-    <taskdef name="groovydoc"
-        classname="org.codehaus.groovy.ant.Groovydoc"
-        />
+    <taskdef name="groovydoc" classname="org.codehaus.groovy.ant.Groovydoc"/>
     <target name="generate">
         <echo>Generating groovy doc</echo>
     	<echo message="sourcePath is ${sp}" />
@@ -46,52 +44,11 @@
             private="false">
         	<!-- This line linking to the repast Java API doesn't appear to work -->
         	<link packages="repast.simphony." href="https://repast.github.io/docs/api/repast_simphony/"/>
-        	<link packages="java.,org.xml.,javax.,org.xml." href="http://docs.oracle.com/javase/8/docs/api/"/>
+        	<link packages="java.,org.xml.,javax.,org.xml." href="https://docs.oracle.com/en/java/javase/11/docs/api/index.html"/>
         	<link packages="org.apache.ant.,org.apache.tools.ant." href="http://www.dpml.net/api/ant/1.7.0"/>
         	<link packages="org.junit.,junit.framework." href="http://junit.sourceforge.net/junit3.8.1/javadoc/"/>
         	<link packages="groovy." href="http://docs.groovy-lang.org/latest/html/groovy-jdk/"/>
         </groovydoc>
-    	<!-- Below was an attempt to use both groovydoc and javadoc and combine the results. It was not successful. -->
-    	<!--<javadoc
-    		classpath="../repast.simphony.core/bin:../repast.simphony.userpanel.ui/bin:../repast.simphony.runtime/bin:../repast.simphony.essentials/bin:../repast.simphony.gui/bin:../repast.simphony.integration/bin:../repast.simphony.data/bin:../saf.core.ui/saf.core.ui.jar:../saf.core.ui/saf.core.v3d.jar:../repast.simphony.relogo.ide/bin:../libs.piccolo/lib/piccolo.jar:../libs.piccolo/lib/piccolox.jar:../repast.simphony.visualization/bin:../repast.simphony.scenario/bin:./bin:/Applications/groovy-1.8.5/embeddable/groovy-all-1.8.5.jar:../repast.simphony.core/lib/collections-generic-4.01.jar:../repast.simphony.core/lib/colt-1.2.0-no_hep.jar"
-    		access="public"
-    		author="true"
-			destdir="${javaDocsDirectory}"
-			nodeprecated="false"
-			nodeprecatedlist="false"
-			noindex="false"
-			nonavbar="false"
-			notree="false"
-			packagenames="**.*"
-    		source="1.6"
-    		sourcepath="src"
-			splitindex="true"
-			use="true"
-			version="true"
-    		windowtitle="${title}"
-			doctitle="${title}"
-    		header="${title}"
-    		footer="${docFooter}"
-    		>
-    		<link href="http://docs.oracle.com/javase/6/docs/api/"/>
-    		<link href="http://www.dpml.net/api/ant/1.7.0"/>
-    		<link href="http://junit.sourceforge.net/junit3.8.1/javadoc/"/>
-    		<link href="http://groovy.codehaus.org/gapi/"/>
-    		<link offline="true" href="../${docsDirectory}" packagelistloc="/Users/jozik/temp/ReLogo API/package-list" resolveLink="true"/>
-    		<link href="http://repast.sourceforge.net/docs/api/repastjava/"/>
-    	</javadoc>-->
-    	<!--<copy todir="${docsDirectory}/repast" overwrite="true">
-			<fileset dir="${javaDocsDirectory}/repast" casesensitive="no">
-    			<exclude name="**/package-*" />
-			</fileset>
-    	</copy>
-    	<mkdir dir="${docsDirectory}/resources"/>
-    	<copy todir="${docsDirectory}/resources" overwrite="true">
-    				<fileset dir="${javaDocsDirectory}/resources" casesensitive="no"/>
-    	</copy>
-    	<delete includeemptydirs="true">
-    		<fileset dir="${javaDocsDirectory}" casesensitive="no">
-    		</fileset>
-    	</delete>-->
+
     </target>
 </project>