svn commit: r1779795 - /aries/trunk/blueprint/plugin/blueprint-maven-plugin-annotation/src/main/java/org/apache/aries/blueprint/annotation/config/ConfigProperties.java

[alien11689]

Author: alien11689
Date: Sun Jan 22 12:13:16 2017
New Revision: 1779795

URL: http://svn.apache.org/viewvc?rev=1779795&view=rev
Log:
[DOCUMENTATION] Add javadoc for @ConfigProperties

Modified:
    
aries/trunk/blueprint/plugin/blueprint-maven-plugin-annotation/src/main/java/org/apache/aries/blueprint/annotation/config/ConfigProperties.java

Modified: 
aries/trunk/blueprint/plugin/blueprint-maven-plugin-annotation/src/main/java/org/apache/aries/blueprint/annotation/config/ConfigProperties.java
URL: 
http://svn.apache.org/viewvc/aries/trunk/blueprint/plugin/blueprint-maven-plugin-annotation/src/main/java/org/apache/aries/blueprint/annotation/config/ConfigProperties.java?rev=1779795&r1=1779794&r2=1779795&view=diff
==============================================================================
--- 
aries/trunk/blueprint/plugin/blueprint-maven-plugin-annotation/src/main/java/org/apache/aries/blueprint/annotation/config/ConfigProperties.java
 (original)
+++ 
aries/trunk/blueprint/plugin/blueprint-maven-plugin-annotation/src/main/java/org/apache/aries/blueprint/annotation/config/ConfigProperties.java
 Sun Jan 22 12:13:16 2017
@@ -23,10 +23,21 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Annotating any parameter with this will create a
+ * cm:cm-properties element in blueprint and inject such
+ * properties into annotated place
+ */
 @Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface ConfigProperties {
+    /**
+     * @return persistent id of configuration
+     */
     String pid();
 
+    /**
+     * @return should update on each properties change
+     */
     boolean update() default false;
 }