You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ss...@apache.org on 2019/01/11 16:24:46 UTC
[sling-maven-sling-plugin] branch master updated: fix javadoc
errors/warnings
This is an automated email from the ASF dual-hosted git repository.
sseifert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-maven-sling-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new d588b42 fix javadoc errors/warnings
d588b42 is described below
commit d588b42c1e6bc6e8c80044c6c521e2409b7a6411
Author: sseifert <ss...@pro-vision.de>
AuthorDate: Fri Jan 11 17:24:34 2019 +0100
fix javadoc errors/warnings
---
.../sling/maven/bundlesupport/AbstractBundleDeployMojo.java | 10 +++++-----
.../sling/maven/bundlesupport/AbstractBundleInstallMojo.java | 3 ++-
.../sling/maven/bundlesupport/AbstractBundlePostMojo.java | 6 +++---
.../java/org/apache/sling/maven/bundlesupport/JsonSupport.java | 1 +
.../apache/sling/maven/bundlesupport/deploy/DeployMethod.java | 1 +
.../maven/bundlesupport/fsresource/FileVaultXmlMounter.java | 4 ++--
.../bundlesupport/fsresource/SlingInitialContentMounter.java | 6 +++---
7 files changed, 17 insertions(+), 14 deletions(-)
diff --git a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleDeployMojo.java b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleDeployMojo.java
index 62935d6..bdff661 100644
--- a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleDeployMojo.java
+++ b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleDeployMojo.java
@@ -131,11 +131,11 @@ abstract class AbstractBundleDeployMojo extends AbstractBundlePostMojo {
/**
* Change the version in jar
- *
- * @param newVersion
- * @param file
- * @return
- * @throws MojoExecutionException
+ * @param file File
+ * @param oldVersion Old version
+ * @param newVersion New version
+ * @return File
+ * @throws MojoExecutionException Exception
*/
protected File changeVersion(File file, String oldVersion, String newVersion)
throws MojoExecutionException {
diff --git a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java
index c1efd5e..af84748 100644
--- a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java
+++ b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundleInstallMojo.java
@@ -47,7 +47,7 @@ abstract class AbstractBundleInstallMojo extends AbstractBundlePostMojo {
* Make sure that {@link #slingUrl} points to the Felix Web Console in that case.</li>
* <li><strong>WebDAV</strong>, uses <a href="https://sling.apache.org/documentation/development/repository-based-development.html">
* WebDAV</a> for deployment (HTTP PUT). Make sure that {@link #slingUrl} points to the entry path of
- * the Sling WebDAV bundle (defaults to <tt>/dav/default<tt> in the Sling starter). Issues a HTTP Delete for the uninstall goal.
+ * the Sling WebDAV bundle (defaults to <tt>/dav/default</tt> in the Sling starter). Issues a HTTP Delete for the uninstall goal.</li>
* <li><strong>SlingPostServlet</strong>, uses the
* <a href="https://sling.apache.org/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Sling Post Servlet</a> for deployment (HTTP POST).
* Make sure that {@link #slingUrl} points a path which is handled by the Sling POST Servlet (usually below regular Sling root URL).</li>
@@ -153,6 +153,7 @@ abstract class AbstractBundleInstallMojo extends AbstractBundlePostMojo {
/**
* Retrieve the bundle deployment method matching the configuration.
* @return bundle deployment method matching the plugin configuration.
+ * @throws MojoExecutionException Exception
*/
protected BundleDeploymentMethod getDeploymentMethod() throws MojoExecutionException {
if (this.deploymentMethod == null) {
diff --git a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundlePostMojo.java b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundlePostMojo.java
index a9cc085..8abfa94 100644
--- a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundlePostMojo.java
+++ b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/AbstractBundlePostMojo.java
@@ -144,7 +144,7 @@ abstract class AbstractBundlePostMojo extends AbstractMojo {
}
/**
- * Returns the combination of <code>sling.url</code> and <code>sling.urlSuffix</code>.
+ * @return Returns the combination of <code>sling.url</code> and <code>sling.urlSuffix</code>.
*/
protected String getTargetURL() {
String targetURL = slingUrl;
@@ -155,7 +155,7 @@ abstract class AbstractBundlePostMojo extends AbstractMojo {
}
/**
- * Returns the combination of <code>sling.console.url</code> and <code>sling.urlSuffix</code>.
+ * @return Returns the combination of <code>sling.console.url</code> and <code>sling.urlSuffix</code>.
*/
protected String getConsoleTargetURL() {
String targetURL = StringUtils.defaultString(slingConsoleUrl, slingUrl);
@@ -166,7 +166,7 @@ abstract class AbstractBundlePostMojo extends AbstractMojo {
}
/**
- * Get the http client
+ * @return Get the http client
*/
protected HttpClient getHttpClient() {
final HttpClient client = new HttpClient();
diff --git a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/JsonSupport.java b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/JsonSupport.java
index 3ce333c..1586438 100644
--- a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/JsonSupport.java
+++ b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/JsonSupport.java
@@ -78,6 +78,7 @@ public final class JsonSupport {
/**
* Validate JSON structure
* @param jsonString JSON string
+ * @param tickToDoubleQuote Tick to double quote
* @throws javax.json.JsonException when JSON structure is invalid
*/
public static void validateJsonStructure(String jsonString, boolean tickToDoubleQuote) {
diff --git a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/deploy/DeployMethod.java b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/deploy/DeployMethod.java
index 6899fd6..cdf3454 100644
--- a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/deploy/DeployMethod.java
+++ b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/deploy/DeployMethod.java
@@ -41,6 +41,7 @@ public interface DeployMethod {
* Undeploy/uninstall a bundle on a Sling instance.
* @param targetURL Target URL
* @param file Bundle file
+ * @param bundleSymbolicName Bundle symbolic name
* @param context Deploy context parameters
* @throws MojoExecutionException Mojo execution execution
*/
diff --git a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/FileVaultXmlMounter.java b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/FileVaultXmlMounter.java
index 98d1037..d61685f 100644
--- a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/FileVaultXmlMounter.java
+++ b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/FileVaultXmlMounter.java
@@ -51,7 +51,7 @@ public final class FileVaultXmlMounter {
* @param targetUrl The web console base url
* @param jcrRootFile jcr_root directory
* @param filterXmlFile FileVault Filter XML file
- * @throws MojoExecutionException
+ * @throws MojoExecutionException Exception
*/
public void mount(final String targetUrl, final File jcrRootFile, final File filterXmlFile) throws MojoExecutionException {
log.info("Trying to configure file system provider...");
@@ -77,7 +77,7 @@ public final class FileVaultXmlMounter {
* @param targetUrl The web console base url
* @param jcrRootFile jcr_root directory
* @param filterXmlFile FileVault Filter XML file
- * @throws MojoExecutionException
+ * @throws MojoExecutionException Exception
*/
public void unmount(final String targetUrl, final File jcrRootFile, final File filterXmlFile) throws MojoExecutionException {
log.info("Removing file system provider configurations...");
diff --git a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/SlingInitialContentMounter.java b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/SlingInitialContentMounter.java
index f95f5fc..2899966 100644
--- a/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/SlingInitialContentMounter.java
+++ b/sling-maven-plugin/src/main/java/org/apache/sling/maven/bundlesupport/fsresource/SlingInitialContentMounter.java
@@ -58,7 +58,7 @@ public final class SlingInitialContentMounter {
* Add configurations to a running OSGi instance for initial content.
* @param targetUrl The web console base url
* @param bundleFile The artifact (bundle)
- * @throws MojoExecutionException
+ * @throws MojoExecutionException Exception
*/
public void mount(final String targetUrl, final File bundleFile) throws MojoExecutionException {
// first, let's get the manifest and see if initial content is configured
@@ -161,7 +161,7 @@ public final class SlingInitialContentMounter {
* Remove configurations from a running OSGi instance for initial content.
* @param targetUrl The web console base url
* @param bundleFile The artifact (bundle)
- * @throws MojoExecutionException
+ * @throws MojoExecutionException Exception
*/
public void unmount(final String targetUrl, final File bundleFile) throws MojoExecutionException {
log.info("Removing file system provider configurations...");
@@ -175,7 +175,7 @@ public final class SlingInitialContentMounter {
* Get the manifest from the File.
* @param bundleFile The bundle jar
* @return The manifest.
- * @throws IOException
+ * @throws IOException Exception
*/
private Manifest getManifest(final File bundleFile) throws IOException {
JarFile file = null;