felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fmesc...@apache.org
Subject svn commit: r1025945 - /felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/Property.java
Date Thu, 21 Oct 2010 11:04:51 GMT
Author: fmeschbe
Date: Thu Oct 21 11:04:51 2010
New Revision: 1025945

URL: http://svn.apache.org/viewvc?rev=1025945&view=rev
Log:
Clarify propertyPrivate JavaDoc

Modified:
    felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/Property.java

Modified: felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/Property.java
URL: http://svn.apache.org/viewvc/felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/Property.java?rev=1025945&r1=1025944&r2=1025945&view=diff
==============================================================================
--- felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/Property.java
(original)
+++ felix/trunk/scrplugin/annotations/src/main/java/org/apache/felix/scr/annotations/Property.java
Thu Oct 21 11:04:51 2010
@@ -153,13 +153,17 @@ public @interface Property {
     /**
      * Boolean flag defining whether a metatype descriptor entry should be
      * generated for this property or not. By default a metatype descriptor
-     * entry, i.e. an AD element, is generated except for the properties
+     * entry, i.e. an <code>AD</code> element, is generated. If a property
+     * should not be available for display in a configuration user interface,
+     * this parameter should be set to <code>true</code>. For properties names
+     * <code>service.ranking</code> the <code>AD</code> element is
not created
+     * by default, which can be overwritten by stating
+     * <code>propertyPrivate=false</code>. For the predefined properties
      * <code>service.pid</code>, <code>service.description</code>,
-     * <code>service.id</code>, <code>service.ranking</code>,
-     * <code>service.vendor</code>, <code>service.bundlelocation</code>
and
-     * <code>service.factoryPid</code>. If a property should not be available
-     * for display in a configuration user interface, this parameter should be
-     * set to true.
+     * <code>service.id</code>, <code>service.vendor</code>,
+     * <code>service.bundlelocation</code> and <code>service.factoryPid</code>
+     * an <code>AD</code> element will never be created and the
+     * <code>propertyPrivate</code> attribute has no effect.
      */
     boolean propertyPrivate() default false;
 



Mime
View raw message