[sling-scriptingbundle-maven-plugin] branch master updated: SLING-9527 - Add a proper documentation page for the Scripting Bundle Maven Plugin

[radu]

This is an automated email from the ASF dual-hosted git repository.

radu pushed a commit to branch master
in repository 
https://gitbox.apache.org/repos/asf/sling-scriptingbundle-maven-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 0e35eaf  SLING-9527 - Add a proper documentation page for the 
Scripting Bundle Maven Plugin
0e35eaf is described below

commit 0e35eafee1721b2c4348177a02db992feb69a390
Author: Radu Cotescu <r...@apache.org>
AuthorDate: Thu Jun 18 14:03:57 2020 +0200

    SLING-9527 - Add a proper documentation page for the Scripting Bundle Maven 
Plugin
---
 .../org/apache/sling/scriptingbundle/maven/plugin/MetadataMojo.java  | 5 +++--
 src/site/markdown/usage.md.vm                                        | 4 ++++
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/sling/scriptingbundle/maven/plugin/MetadataMojo.java 
b/src/main/java/org/apache/sling/scriptingbundle/maven/plugin/MetadataMojo.java
index fb71657..c9a172f 100644
--- 
a/src/main/java/org/apache/sling/scriptingbundle/maven/plugin/MetadataMojo.java
+++ 
b/src/main/java/org/apache/sling/scriptingbundle/maven/plugin/MetadataMojo.java
@@ -87,8 +87,7 @@ public class MetadataMojo extends AbstractMojo {
     /**
      * Allows defining a list of excluded files and folders or patterns to 
filter which files should be excluded in the analysis for
      * generating capabilities.
-     * <p>
-     * The following list provides the default excluded files and patterns:
+     * <p>The following list provides the default excluded files and patterns:
      * <dl>
      * <dt>
      *     Miscellaneous typical temporary files
@@ -169,6 +168,8 @@ public class MetadataMojo extends AbstractMojo {
      * <pre>
      *     org/apache/sling/example
      * </pre>
+     *
+     * @since 0.2.0
      */
     @Parameter(property = "scriptingbundle.searchPaths")
     private Set<String> searchPaths;
diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm
index 30e0f58..2e0072a 100644
--- a/src/site/markdown/usage.md.vm
+++ b/src/site/markdown/usage.md.vm
@@ -29,6 +29,10 @@ page. In addition to the normal way of structuring scripts 
in the file tree, the
      A `requires` file (assuming the same conventions and syntax as for the 
`extends` file) will generate a `Require-Capability` for each
      line based on the given `resourceType` and version range.
 
+  4. The Resource Type can have the form of a path or of a Java package name 
(e.g. `com.mydomain.components.image`). When the resource type
+     is defined as a package name, the resource type label will be the last 
subpackage (i.e. for `com.mydomain.components.image`, the
+     resource type label will be `image`).
+
 $h3 Defining scripts
 As an example, let's assume the following layout:
 ```