LDEV-4999 add core to javadocs

https://luceeserver.atlassian.net/browse/LDEV-4999
zspitzer · Jul 7, 2024 · 5da59d5 · 5da59d5
1 parent 2f4d9e4
commit 5da59d5
Show file tree

Hide file tree

Showing 12 changed files with 17 additions and 14 deletions.
diff --git a/ant/build-core.xml b/ant/build-core.xml
@@ -400,7 +400,7 @@
       target="11" 
       destdir="${core}"
       includeantruntime="false"
-      debug="true" 
+      debug="true"
       debuglevel="lines,vars,source">
        <classpath refid="classpath" />
        <classpath path="${temp}/loader"/>

diff --git a/core/src/main/java/lucee/aprint.java b/core/src/main/java/lucee/aprint.java
@@ -52,7 +52,7 @@
 import lucee.runtime.type.QueryImpl;
 
 /**
- *  
+ *  debug print class
  */
 public class aprint {
 	public static void edate(String value) {

diff --git a/core/src/main/java/lucee/runtime/functions/arrays/Array_.java b/core/src/main/java/lucee/runtime/functions/arrays/Array_.java
@@ -39,7 +39,6 @@ public class Array_ extends BIF {
 	 * @param pc
 	 * @param objArr
 	 * @return
-	 * @throws ExpressionException
 	 */
 	public static Array call(PageContext pc, Object[] objArr) {
 		/*

diff --git a/core/src/main/java/lucee/runtime/monitor/ActionMonitorCollectorImpl.java b/core/src/main/java/lucee/runtime/monitor/ActionMonitorCollectorImpl.java
@@ -44,7 +44,6 @@ public void addMonitor(ConfigServer cs, ActionMonitor monitor, String name, bool
 	 * 
 	 * @param pc
 	 * @param ar
-	 * @throws IOException
 	 */
 	@Override
 	public void log(PageContext pc, String type, String label, long executionTime, Object data) {

diff --git a/core/src/main/java/lucee/runtime/tag/Application.java b/core/src/main/java/lucee/runtime/tag/Application.java
@@ -598,7 +598,7 @@ public void setS3(Struct s3) {
 	}
 
 	/**
-	 * @param s3 the s3 to set
+	 * @param ftp the ftp to set
 	 */
 	public void setFtp(Struct ftp) {
 		this.ftp = ftp;
@@ -681,7 +681,7 @@ public void setLoginstorage(String loginstorage) throws ApplicationException {
 	}
 
 	/**
-	 * @param scriptrotect the scriptrotect to set
+	 * @param strScriptrotect the scriptrotect to set
 	 */
 	public void setScriptprotect(String strScriptrotect) {
 		this.scriptrotect = strScriptrotect;

diff --git a/core/src/main/java/lucee/runtime/type/KeyImpl.java b/core/src/main/java/lucee/runtime/type/KeyImpl.java
@@ -177,7 +177,7 @@ public static Collection.Key initKeys(String key) {
 	/**
 	 * for dynamic loading of key objects
 	 * 
-	 * @param string
+	 * @param key
 	 * @return
 	 */
 	public static Collection.Key init(String key) {

diff --git a/core/src/main/java/lucee/runtime/type/it/ArrayListIteratorImpl.java b/core/src/main/java/lucee/runtime/type/it/ArrayListIteratorImpl.java
@@ -33,7 +33,7 @@ public class ArrayListIteratorImpl implements ListIterator {
 	/**
 	 * Constructor of the class
 	 * 
-	 * @param arr
+	 * @param array
 	 * @param index
 	 */
 	public ArrayListIteratorImpl(Array array, int index) {

diff --git a/core/src/main/java/lucee/transformer/bytecode/expression/ExpressionBase.java b/core/src/main/java/lucee/transformer/bytecode/expression/ExpressionBase.java
@@ -69,7 +69,7 @@ public final Type writeOutAsType(Context c, int mode) throws TransformerExceptio
 	 * @param adapter
 	 * @param mode
 	 * @return return Type of expression
-	 * @throws TemplateException
+	 * @throws TransformerException
 	 */
 	public abstract Type _writeOut(BytecodeContext bc, int mode) throws TransformerException;
 

diff --git a/core/src/main/java/lucee/transformer/bytecode/statement/Argument.java b/core/src/main/java/lucee/transformer/bytecode/statement/Argument.java
@@ -47,8 +47,9 @@ public final class Argument {
 	 * @param required
 	 * @param defaultValue
 	 * @param displayName
+	 * @param passByReference
+	 * @param displayName
 	 * @param hint
-	 * @param hint2
 	 * @param meta
 	 */
 	public Argument(Expression name, Expression type, Expression required, Expression defaultValue, ExprBoolean passByReference, Expression displayName, Expression hint,

diff --git a/core/src/main/java/lucee/transformer/bytecode/statement/StatementBase.java b/core/src/main/java/lucee/transformer/bytecode/statement/StatementBase.java
@@ -71,7 +71,7 @@ public void setParent(Statement parent) {
 	 * write out the statement to adapter
 	 * 
 	 * @param adapter
-	 * @throws TemplateException
+	 * @throws TransformerException
 	 */
 	@Override
 	public final void writeOut(Context c) throws TransformerException {

diff --git a/core/src/main/java/lucee/transformer/cfml/evaluator/FunctionEvaluator.java b/core/src/main/java/lucee/transformer/cfml/evaluator/FunctionEvaluator.java
@@ -39,7 +39,7 @@ public interface FunctionEvaluator {
 	 * 
 	 * @param bif
 	 * @param flf the definition of the function from the fld file
-	 * @throws TemplateException
+	 * @throws EvaluatorException
 	 */
 	public void evaluate(BIF bif, FunctionLibFunction flf) throws EvaluatorException;
 

diff --git a/loader/pom.xml b/loader/pom.xml
@@ -149,7 +149,10 @@
         <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-          <version>3.5.0</version>
+          <version>3.7.0</version>
+          <configuration>
+            <sourcepath>src/main/java;../core/src/main/java</sourcepath>
+          </configuration>
           <executions>
             <execution>
               <id>attach-javadocs</id>
@@ -158,9 +161,10 @@
               </goals>
 
             <configuration>
-               <source>8</source>
+               <source>11</source>
                <detectJavaApiLink>false</detectJavaApiLink>
                <quiet>true</quiet>
+               <additionalparam>-Xdoclint:none</additionalparam>
                <!-- add this to disable checking
                 <additionalparam>-Xdoclint:none</additionalparam>
                -->