brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henev...@apache.org
Subject [04/10] incubator-brooklyn git commit: Documentation improvements
Date Thu, 13 Nov 2014 12:44:11 GMT
Documentation improvements


Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/0dc8e38c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/0dc8e38c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/0dc8e38c

Branch: refs/heads/master
Commit: 0dc8e38c4acb510046a3ae5674aab86d96065fb0
Parents: ed00435
Author: Sam Corbett <sam.corbett@cloudsoftcorp.com>
Authored: Wed Nov 12 23:26:43 2014 +0000
Committer: Sam Corbett <sam.corbett@cloudsoftcorp.com>
Committed: Wed Nov 12 23:26:43 2014 +0000

----------------------------------------------------------------------
 core/src/main/java/brooklyn/enricher/Enrichers.java       | 10 +++++++---
 .../java/brooklyn/entity/basic/AbstractGroupImpl.java     |  2 +-
 .../entity/group/AbstractMembershipTrackingPolicy.java    |  5 ++++-
 .../java/brooklyn/entity/webapp/JavaWebAppDriver.java     | 10 ++++++----
 usage/downstream-parent/pom.xml                           |  2 +-
 5 files changed, 19 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0dc8e38c/core/src/main/java/brooklyn/enricher/Enrichers.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/enricher/Enrichers.java b/core/src/main/java/brooklyn/enricher/Enrichers.java
index 48b7a56..a474f37 100644
--- a/core/src/main/java/brooklyn/enricher/Enrichers.java
+++ b/core/src/main/java/brooklyn/enricher/Enrichers.java
@@ -135,12 +135,16 @@ public class Enrichers {
             return new PropagatorBuilder(true, vals);
         }
         
-        /** builds an enricher which transforms a given sensor:
-         * <li> applying a (required) function ({@link TransformerBuilder#computing(Function)},
or {@link TransformerBuilder#computingAverage()}/{@link TransformerBuilder#computingSum()},
mandatory);
+        /**
+         * Builds an enricher which transforms a given sensor:
+         * <li> applying a (required) function ({@link TransformerBuilder#computing(Function)},
or
+         *      {@link AbstractAggregatorBuilder#computingAverage()}/
+         *      {@link AbstractAggregatorBuilder#computingSum()}, mandatory);
          * <li> and publishing it on the entity where the enricher is attached;
          * <li> optionally taking the sensor from a different source entity ({@link
TransformerBuilder#from(Entity)});
          * <li> and optionally publishing it as a different sensor ({@link TransformerBuilder#publishing(AttributeSensor)});
-         * <p> (You must supply at least one of the optional values, of course, otherwise
the enricher may loop endlessly!) */
+         * <p> You must supply at least one of the optional values, of course, otherwise
the enricher may loop endlessly!
+         */
         public <S> TransformerBuilder<S, Object> transforming(AttributeSensor<S>
val) {
             return new TransformerBuilder<S, Object>(val);
         }

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0dc8e38c/core/src/main/java/brooklyn/entity/basic/AbstractGroupImpl.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/entity/basic/AbstractGroupImpl.java b/core/src/main/java/brooklyn/entity/basic/AbstractGroupImpl.java
index 837003c..1b40603 100644
--- a/core/src/main/java/brooklyn/entity/basic/AbstractGroupImpl.java
+++ b/core/src/main/java/brooklyn/entity/basic/AbstractGroupImpl.java
@@ -54,7 +54,7 @@ import com.google.common.collect.Sets;
  * current number of members.
  */
 public abstract class AbstractGroupImpl extends AbstractEntity implements AbstractGroup {
-    private static final Logger log = LoggerFactory.getLogger(AbstractGroup.class);
+    private static final Logger log = LoggerFactory.getLogger(AbstractGroupImpl.class);
 
     private Set<Entity> members = Sets.newLinkedHashSet();
 

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0dc8e38c/core/src/main/java/brooklyn/entity/group/AbstractMembershipTrackingPolicy.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/entity/group/AbstractMembershipTrackingPolicy.java
b/core/src/main/java/brooklyn/entity/group/AbstractMembershipTrackingPolicy.java
index abc5e9d..22a2917 100644
--- a/core/src/main/java/brooklyn/entity/group/AbstractMembershipTrackingPolicy.java
+++ b/core/src/main/java/brooklyn/entity/group/AbstractMembershipTrackingPolicy.java
@@ -46,7 +46,10 @@ import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.reflect.TypeToken;
 
-/** abstract class which helps track membership of a group, invoking (empty) methods in this
class on MEMBER{ADDED,REMOVED} events, as well as SERVICE_UP {true,false} for those members.
*/
+/**
+ * Abstract class which helps track membership of a group, invoking (empty) methods in this
class
+ * on MEMBER{ADDED,REMOVED} events, as well as SERVICE_UP {true,false} for those members.
+ */
 public abstract class AbstractMembershipTrackingPolicy extends AbstractPolicy {
     private static final Logger LOG = LoggerFactory.getLogger(AbstractMembershipTrackingPolicy.class);
     

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0dc8e38c/software/webapp/src/main/java/brooklyn/entity/webapp/JavaWebAppDriver.java
----------------------------------------------------------------------
diff --git a/software/webapp/src/main/java/brooklyn/entity/webapp/JavaWebAppDriver.java b/software/webapp/src/main/java/brooklyn/entity/webapp/JavaWebAppDriver.java
index 3206ff9..f355555 100644
--- a/software/webapp/src/main/java/brooklyn/entity/webapp/JavaWebAppDriver.java
+++ b/software/webapp/src/main/java/brooklyn/entity/webapp/JavaWebAppDriver.java
@@ -38,15 +38,17 @@ public interface JavaWebAppDriver extends JavaSoftwareProcessDriver {
     void deploy(File f, String targetName);
 
     /**
-     * deploys a URL as a webapp at the appserver;
-     * returns a token which can be used as an argument to undeploy,
-     * typically the web context with leading slash where the app can be reached (just "/"
for ROOT)
+     * Deploys a URL as a webapp at the appserver.
      * <p>
-     * see {@link JavaWebAppSoftwareProcess#deploy(String, String)} for details of how input
filenames are handled
+     * See {@link JavaWebAppSoftwareProcess#deploy(String, String)} for details of how input
filenames are handled.
+     *
+     * @return A token which can be used as an argument to undeploy.
+     *     Typically the web context with leading slash where the app can be reached (just
"/" for ROOT)
      */
     String deploy(String url, String targetName);
     
     void undeploy(String targetName);
     
     FilenameToWebContextMapper getFilenameContextMapper();
+
 }

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/0dc8e38c/usage/downstream-parent/pom.xml
----------------------------------------------------------------------
diff --git a/usage/downstream-parent/pom.xml b/usage/downstream-parent/pom.xml
index 251f5b2..bd70840 100644
--- a/usage/downstream-parent/pom.xml
+++ b/usage/downstream-parent/pom.xml
@@ -32,7 +32,7 @@
   </description>
 
   <properties>
-    <!-- Compilatin -->
+    <!-- Compilation -->
     <java.version>1.6</java.version>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>


Mime
View raw message