You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by me...@apache.org on 2025/01/15 14:39:37 UTC
(myfaces-build-tools) branch main updated: Fix spelling / word case (#45)
This is an automated email from the ASF dual-hosted git repository.
melloware pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/myfaces-build-tools.git
The following commit(s) were added to refs/heads/main by this push:
new c9e584ee Fix spelling / word case (#45)
c9e584ee is described below
commit c9e584eeda1a85369e6c80f1481c1b27b2b74c36
Author: John Bampton <jb...@users.noreply.github.com>
AuthorDate: Thu Jan 16 00:39:32 2025 +1000
Fix spelling / word case (#45)
---
maven2-plugins/myfaces-jsdoc-plugin/pom.xml | 2 +-
.../apache/myfaces/plugins/jsdoc/AbstractJSDocMojo.java | 16 ++++++++--------
.../org/apache/myfaces/plugins/jsdoc/JSDocHelper.java | 4 ++--
.../org/apache/myfaces/plugins/jsdoc/JSDocJarMojo.java | 8 ++++----
.../java/org/apache/myfaces/plugins/jsdoc/JSDocMojo.java | 4 ++--
.../apache/myfaces/plugins/jsdoc/JSDocReportMojo.java | 12 ++++++------
.../plugins/jsdoc/util/HTMLFileContentFilter.java | 2 +-
.../org/apache/myfaces/plugins/jsdoc/util/JSDocPack.java | 2 +-
.../myfaces/plugins/jsdoc/util/JSDocPackMaven.java | 10 +++++-----
.../myfaces/plugins/jsdoc/util/JSDocPackResources.java | 2 +-
10 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/pom.xml b/maven2-plugins/myfaces-jsdoc-plugin/pom.xml
index 95ea5af5..ce97a4a3 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/pom.xml
+++ b/maven2-plugins/myfaces-jsdoc-plugin/pom.xml
@@ -109,7 +109,7 @@
<version>1.7R1</version>
</dependency>
- <!-- note jsdoc throws a lot of warnings
+ <!-- note JSDoc throws a lot of warnings
which will be gone in 2.4 -->
<dependency>
<groupId>org.jsdoctoolkit</groupId>
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/AbstractJSDocMojo.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/AbstractJSDocMojo.java
index b1f5ac72..cf231d73 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/AbstractJSDocMojo.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/AbstractJSDocMojo.java
@@ -119,7 +119,7 @@ public abstract class AbstractJSDocMojo extends AbstractMojo
protected String relativeWebappDirectory;
/**
- * Specifies the destination directory where jsdoc saves the generated HTML files.
+ * Specifies the destination directory where JSDoc saves the generated HTML files.
*
* @parameter expression="${destDir}" alias="destDir" default-value="${project.build.directory}/jsdoc"
* @required
@@ -145,7 +145,7 @@ public abstract class AbstractJSDocMojo extends AbstractMojo
// Standard JSDoc Options
// ----------------------------------------------------------------------
- //various jsdoc params, copied over as well as the corresponding snippets from
+ //various JSDoc params, copied over as well as the corresponding snippets from
/**
* Whether to include symbols tagged as private. Default is <code>false</code>.
*
@@ -168,7 +168,7 @@ public abstract class AbstractJSDocMojo extends AbstractMojo
protected boolean includeUndocumentedUnderscored;
/**
- * template directory used by jsdoc the default is <code>templates/jsdoc</code> under the jsdoc root
+ * template directory used by JSDoc the default is <code>templates/jsdoc</code> under the JSDoc root
*
* @parameter expression="templates/jsdoc"
*/
@@ -324,9 +324,9 @@ public abstract class AbstractJSDocMojo extends AbstractMojo
private void unpackJSDoc(JSDocHelper helper) throws IOException
{
- getLog().info("[JSDOC] Unpacking jsdoc toolkit for further processing");
+ getLog().info("[JSDOC] Unpacking JSDoc toolkit for further processing");
helper.getUnpacker().unpack(helper.getJsdocEngineUnpacked(), getLog());
- getLog().info("[JSDOC] Unpacking jsdoc toolkit for further processing done");
+ getLog().info("[JSDOC] Unpacking JSDoc toolkit for further processing done");
}
/**
@@ -448,13 +448,13 @@ public abstract class AbstractJSDocMojo extends AbstractMojo
args.addAll(fetchJavascriptSources(helper));
//according to the run.js source the last argument
- //must be a -j param pointing to the jsdoc javascripts
+ //must be a -j param pointing to the JSDoc javascripts
args.add(JSDocMojoConst.PARAM_JS_FLAG + JSDocMojoConst.EQUALS + runJsPath);
return args;
}
/**
- * @return the directory as absolute path holding the jsdoc toolkit templates
+ * @return the directory as absolute path holding the JSDoc toolkit templates
*/
private final String getTemplateDirectory(JSDocHelper helper)
{
@@ -464,7 +464,7 @@ public abstract class AbstractJSDocMojo extends AbstractMojo
}
/**
- * @return the target directory for the jsdoc files
+ * @return the target directory for the JSDoc files
*/
/*
private final String getOutputDirectory()
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocHelper.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocHelper.java
index e1ce17c0..afbd1cbb 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocHelper.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocHelper.java
@@ -31,7 +31,7 @@ public class JSDocHelper
private JSDocPack unpacker;
/**
- * target path for the unpacked jsdoc engine
+ * target path for the unpacked JSDoc engine
*/
private String jsdocEngineUnpacked = null;
@@ -41,7 +41,7 @@ public class JSDocHelper
private String javascriptTargetPath = null;
/**
- * run path for the jsdoc engine
+ * run path for the JSDoc engine
*/
private String jsdocRunPath = null;
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocJarMojo.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocJarMojo.java
index 0922d571..e236a051 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocJarMojo.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocJarMojo.java
@@ -39,12 +39,12 @@ import org.codehaus.plexus.archiver.jar.ManifestException;
* Leonardo Uribe
* @version 1.0.0
* <p/>
- * A simple jsdoc plugin which should cover our documentation needs
+ * A simple JSDoc plugin which should cover our documentation needs
* Note this plugin is a simplified tailored derivative from
* <p/>
* http://www.abiss.gr some code stems from there.
* <p/>
- * since we use jsdoc for now and are not in the reporting part
+ * since we use JSDoc for now and are not in the reporting part
* a simple plugin suffices.
* @goal jar
* @phase package
@@ -142,7 +142,7 @@ public class JSDocJarMojo extends AbstractJSDocMojo
{
if ( skip )
{
- getLog().info( "Skipping jsdoc generation" );
+ getLog().info( "Skipping JSDoc generation" );
return;
}
@@ -157,7 +157,7 @@ public class JSDocJarMojo extends AbstractJSDocMojo
if ( !attach )
{
- getLog().info( "NOT adding jsdoc to attached artifacts list." );
+ getLog().info( "NOT adding JSDoc to attached artifacts list." );
}
else
{
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocMojo.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocMojo.java
index e35652fe..90e10752 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocMojo.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocMojo.java
@@ -27,12 +27,12 @@ import org.apache.maven.reporting.MavenReportException;
* @author Werner Punz (latest modification by $Author$)
* @version $Revision$ $Date$
* <p/>
- * A simple jsdoc plugin which should cover our documentation needs
+ * A simple JSDoc plugin which should cover our documentation needs
* Note this plugin is a simplified tailored derivative from
* <p/>
* http://www.abiss.gr some code stems from there.
* <p/>
- * since we use jsdoc for now and are not in the reporting part
+ * since we use JSDoc for now and are not in the reporting part
* a simple plugin suffices.
* @goal jsdoc
*/
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocReportMojo.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocReportMojo.java
index 74691c81..b0d83edd 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocReportMojo.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/JSDocReportMojo.java
@@ -31,12 +31,12 @@ import org.codehaus.doxia.sink.Sink;
/**
* <p/>
- * A simple jsdoc plugin which should cover our documentation needs
+ * A simple JSDoc plugin which should cover our documentation needs
* Note this plugin is a simplified tailored derivative from
* <p/>
* http://www.abiss.gr some code stems from there.
* <p/>
- * since we use jsdoc for now and are not in the reporting part
+ * since we use JSDoc for now and are not in the reporting part
* a simple plugin suffices.
*
* @author Werner Punz (latest modification by $Author$)
@@ -51,7 +51,7 @@ public class JSDocReportMojo extends AbstractJSDocMojo implements MavenReport
// ----------------------------------------------------------------------
/**
- * Specifies the destination directory where jsdoc saves the generated HTML files.
+ * Specifies the destination directory where JSDoc saves the generated HTML files.
*
* @parameter expression="${reportOutputDirectory}" default-value="${project.reporting.outputDirectory}/jsdoc"
* @required
@@ -125,11 +125,11 @@ public class JSDocReportMojo extends AbstractJSDocMojo implements MavenReport
}
catch ( MavenReportException e )
{
- getLog().error( "Error while creating jsdoc report: " + e.getMessage(), e );
+ getLog().error( "Error while creating JSDoc report: " + e.getMessage(), e );
}
catch ( RuntimeException e )
{
- getLog().error( "Error while creating jsdoc report: " + e.getMessage(), e );
+ getLog().error( "Error while creating JSDoc report: " + e.getMessage(), e );
}
}
@@ -211,7 +211,7 @@ public class JSDocReportMojo extends AbstractJSDocMojo implements MavenReport
{
if ( skip )
{
- getLog().info( "Skipping jsdoc generation" );
+ getLog().info( "Skipping JSDoc generation" );
return;
}
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/HTMLFileContentFilter.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/HTMLFileContentFilter.java
index 40d6d2be..b841dd9c 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/HTMLFileContentFilter.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/HTMLFileContentFilter.java
@@ -32,7 +32,7 @@ import java.util.List;
* @author Werner Punz (latest modification by $Author$)
* @version $Revision$ $Date$
* <p/>
- * Since jsdoc adds the full canonical path to our filenames we have to fix it within the generated html
+ * Since JSDoc adds the full canonical path to our filenames we have to fix it within the generated html
*/
public class HTMLFileContentFilter implements IOFileFilter
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPack.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPack.java
index 9b54585a..c5ee7272 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPack.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPack.java
@@ -36,7 +36,7 @@ import java.util.jar.JarFile;
* @author Werner Punz (latest modification by $Author$)
* @version $Revision$ $Date$
* <p/>
- * base class for all our jsdoc unpackers
+ * base class for all our JSDoc unpackers
*/
public abstract class JSDocPack
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackMaven.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackMaven.java
index bdbb8a5a..1fc586b9 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackMaven.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackMaven.java
@@ -26,13 +26,13 @@ import java.util.jar.JarFile;
* @author Werner Punz (latest modification by $Author$)
* @version $Revision$ $Date$
* <p/>
- * An unpacker for the jsdoc toolkit
- * Unfortunately we have to unpack the jsdoc toolkit during
+ * An unpacker for the JSDoc toolkit
+ * Unfortunately we have to unpack the JSDoc toolkit during
* the build process because we have a set of js files
* running via rhino which will not work unless we have them
* on the filesystem instead of the jar.
* <p/>
- * The jsdoc toolkit itself can be streamed in via maven.
+ * The JSDoc toolkit itself can be streamed in via maven.
*/
public class JSDocPackMaven extends JSDocPack
@@ -50,7 +50,7 @@ public class JSDocPackMaven extends JSDocPack
/**
* public method which is called from the outside
- * unpacks the current jsdoc package into our target dir
+ * unpacks the current JSDoc package into our target dir
*
* @param targetDir the target dir to unpack to
* @param log the target log to log into
@@ -63,7 +63,7 @@ public class JSDocPackMaven extends JSDocPack
}
/**
- * fetches the location of the jsdoc hosting jar,
+ * fetches the location of the JSDoc hosting jar,
* the location already should be in maven and our main
* constant is the <code>app/main.js</code> file which should be present
* everywhere
diff --git a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackResources.java b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackResources.java
index 356a2efb..ce020ac0 100644
--- a/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackResources.java
+++ b/maven2-plugins/myfaces-jsdoc-plugin/src/main/java/org/apache/myfaces/plugins/jsdoc/util/JSDocPackResources.java
@@ -30,7 +30,7 @@ import java.util.jar.JarFile;
* @author Werner Punz (latest modification by $Author$)
* @version $Revision$ $Date$
* <p/>
- * unpacks a locally hosted jsdoc (which is placed in our resources folder
+ * unpacks a locally hosted JSDoc (which is placed in our resources folder
*/
public class JSDocPackResources extends JSDocPack