You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polygene.apache.org by ni...@apache.org on 2015/04/17 18:08:32 UTC
[20/50] [abbrv] zest-qi4j git commit: Fixed all JavaDoc ERRORS
reported by DocLint in Java 8.
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/functional/src/main/java/org/qi4j/functional/Functions.java
----------------------------------------------------------------------
diff --git a/core/functional/src/main/java/org/qi4j/functional/Functions.java b/core/functional/src/main/java/org/qi4j/functional/Functions.java
index 8e9e6a6..0b50b35 100644
--- a/core/functional/src/main/java/org/qi4j/functional/Functions.java
+++ b/core/functional/src/main/java/org/qi4j/functional/Functions.java
@@ -35,13 +35,10 @@ public final class Functions
}
/**
- * compose(F1(M,T),F2(F,M)) = F1(F2(F)) -> T
+ * compose(F1(M,T),F2(F,M)) = F1(F2(F)) -> T
*
* @param outer
* @param inner
- * @param <FROM>
- * @param <MIDDLE>
- * @param <TO>
*
* @return
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/io/src/main/java/org/qi4j/io/Input.java
----------------------------------------------------------------------
diff --git a/core/io/src/main/java/org/qi4j/io/Input.java b/core/io/src/main/java/org/qi4j/io/Input.java
index 41647c4..bde80e5 100644
--- a/core/io/src/main/java/org/qi4j/io/Input.java
+++ b/core/io/src/main/java/org/qi4j/io/Input.java
@@ -16,12 +16,13 @@ package org.qi4j.io;
/**
* Input source of data.
- * <p/>
+ * <p>
* Invoke transferTo to send data from this input to given output. transferTo can be invoked
* as many times as you want. The transferTo implementation must ensure that any exceptions thrown
* by the Input or the Output which transferred data is sent to is handled properly, i.e. that resources
* are closed. Any client code to transferTo calls should not have to bother with resource management,
* but may catch exceptions anyway for logging and similar purposes.
+ * </p>
*/
// START SNIPPET: input
public interface Input<T, SenderThrowableType extends Throwable>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/io/src/main/java/org/qi4j/io/Outputs.java
----------------------------------------------------------------------
diff --git a/core/io/src/main/java/org/qi4j/io/Outputs.java b/core/io/src/main/java/org/qi4j/io/Outputs.java
index ca9b2c0..f3fd92f 100644
--- a/core/io/src/main/java/org/qi4j/io/Outputs.java
+++ b/core/io/src/main/java/org/qi4j/io/Outputs.java
@@ -36,9 +36,9 @@ public class Outputs
/**
* Write lines to a text file with UTF-8 encoding. Separate each line with a newline ("\n" character). If the writing or sending fails,
* the file is deleted.
- * <p/>
+ * <p>
* If the filename ends with .gz, then the data is automatically GZipped.
- *
+ * </p>
* @param file the file to save the text to
*
* @return an Output for storing text in a file
@@ -54,9 +54,9 @@ public class Outputs
/**
* Write lines to a text file. Separate each line with a newline ("\n" character). If the writing or sending fails,
* the file is deleted.
- * <p/>
+ * <p>
* If the filename ends with .gz, then the data is automatically GZipped.
- *
+ * </p>
* @param file the file to save the text to
*
* @return an Output for storing text in a file
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/runtime/src/main/java/org/qi4j/runtime/injection/DependencyModel.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/main/java/org/qi4j/runtime/injection/DependencyModel.java b/core/runtime/src/main/java/org/qi4j/runtime/injection/DependencyModel.java
index 2062029..10eca0d 100644
--- a/core/runtime/src/main/java/org/qi4j/runtime/injection/DependencyModel.java
+++ b/core/runtime/src/main/java/org/qi4j/runtime/injection/DependencyModel.java
@@ -209,11 +209,22 @@ public final class DependencyModel
}
/**
- * Get the raw dependency type. If the dependency uses generics this is the raw type,
- * and otherwise it is the type of the field. Examples:<br/>
- * {@code @Service MyService service} -> MyService<br/>
- * {@code @Entity Iterable<Foo> fooList} -> Iterable<br/>
- * {@code @Entity Query<Foo> fooQuery} -> Query<br/>
+ * Get the raw dependency type.
+ * <p>
+ * If the dependency uses generics this is the raw type,
+ * and otherwise it is the type of the field.
+ * </p>
+ * <p>
+ * Examples:
+ * </p>
+ * {@code @Service MyService service} -> MyService
+ * </p>
+ * <p>
+ * {@code @Entity Iterable<Foo> fooList} -> Iterable
+ * </p>
+ * <p>
+ * {@code @Entity Query<Foo> fooQuery} -> Query
+ * </p>
*
* @return raw injection type.
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/runtime/src/main/java/org/qi4j/runtime/service/ImportedServiceReferenceInstance.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/main/java/org/qi4j/runtime/service/ImportedServiceReferenceInstance.java b/core/runtime/src/main/java/org/qi4j/runtime/service/ImportedServiceReferenceInstance.java
index 36bed24..4e792df 100644
--- a/core/runtime/src/main/java/org/qi4j/runtime/service/ImportedServiceReferenceInstance.java
+++ b/core/runtime/src/main/java/org/qi4j/runtime/service/ImportedServiceReferenceInstance.java
@@ -32,11 +32,11 @@ import org.slf4j.LoggerFactory;
/**
* Implementation of ServiceReference. This manages the reference to the imported service.
- * <p/>
+ * <p>
* Whenever the service is requested it is returned directly to the client. That means that
* to handle service passivation and unavailability correctly, any proxying must be done in the
* service importer.
- *
+ * </p>
* @param <T> Service Type
*/
public final class ImportedServiceReferenceInstance<T>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/runtime/src/main/java/org/qi4j/runtime/service/ServiceReferenceInstance.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/main/java/org/qi4j/runtime/service/ServiceReferenceInstance.java b/core/runtime/src/main/java/org/qi4j/runtime/service/ServiceReferenceInstance.java
index 259cfdf..706df16 100644
--- a/core/runtime/src/main/java/org/qi4j/runtime/service/ServiceReferenceInstance.java
+++ b/core/runtime/src/main/java/org/qi4j/runtime/service/ServiceReferenceInstance.java
@@ -36,12 +36,14 @@ import org.qi4j.runtime.activation.ActivationDelegate;
import org.qi4j.runtime.structure.ModuleInstance;
/**
- * Implementation of ServiceReference. This manages the actual instance of the service
- * and implements the service Activation.
- * <p/>
+ * Implementation of ServiceReference.
+ * <p>
+ * This manages the actual instance of the service and implements the service Activation.
+ * </p>
+ * <p>
* Whenever the service is requested a proxy is returned which points to this class. This means
* that the instance can be passivated even though a client is holding on to a service proxy.
- *
+ * </p>
* @param <T> Service Type
*/
public final class ServiceReferenceInstance<T>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/runtime/src/test/java/org/qi4j/test/composite/CleanStackTraceTest.java
----------------------------------------------------------------------
diff --git a/core/runtime/src/test/java/org/qi4j/test/composite/CleanStackTraceTest.java b/core/runtime/src/test/java/org/qi4j/test/composite/CleanStackTraceTest.java
index f5e51ad..7d0d322 100644
--- a/core/runtime/src/test/java/org/qi4j/test/composite/CleanStackTraceTest.java
+++ b/core/runtime/src/test/java/org/qi4j/test/composite/CleanStackTraceTest.java
@@ -34,8 +34,9 @@ import static org.junit.Assume.assumeTrue;
/**
* Test if the stacktrace is cleaned up properly.
- * <p/>
+ * <p>
* NOTE: This satisfiedBy MUST NOT be inside package org.qi4j.runtime, or it will fail.
+ * </p>
*/
public class CleanStackTraceTest
extends AbstractQi4jTest
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/spi/src/main/java/org/qi4j/spi/entity/EntityState.java
----------------------------------------------------------------------
diff --git a/core/spi/src/main/java/org/qi4j/spi/entity/EntityState.java b/core/spi/src/main/java/org/qi4j/spi/entity/EntityState.java
index 2f5c457..2e149ca 100644
--- a/core/spi/src/main/java/org/qi4j/spi/entity/EntityState.java
+++ b/core/spi/src/main/java/org/qi4j/spi/entity/EntityState.java
@@ -37,20 +37,20 @@ public interface EntityState
/**
* Version of the entity. This is managed by the EntityStore.
- * <p/>
+ * <p>
* If the underlying EntityStore does not support versioning, then version
* must always be set to 0.
- *
+ * </p>
* @return version of the entity
*/
String version();
/**
* Last modified timestamp of the entity. This is managed by the EntityStore.
- * <p/>
+ * <p>
* If the underlying EntityStore does not support timestamping, then last modified
* must always be set to the current time.
- *
+ * </p>
* @return last modified timestamp of the entity, as defined by System.currentTimeMillis()
*/
long lastModified();
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/spi/src/main/java/org/qi4j/spi/entitystore/ConcurrentModificationCheckConcern.java
----------------------------------------------------------------------
diff --git a/core/spi/src/main/java/org/qi4j/spi/entitystore/ConcurrentModificationCheckConcern.java b/core/spi/src/main/java/org/qi4j/spi/entitystore/ConcurrentModificationCheckConcern.java
index 8c3e22c..cfeead6 100644
--- a/core/spi/src/main/java/org/qi4j/spi/entitystore/ConcurrentModificationCheckConcern.java
+++ b/core/spi/src/main/java/org/qi4j/spi/entitystore/ConcurrentModificationCheckConcern.java
@@ -30,12 +30,13 @@ import java.util.concurrent.locks.ReentrantReadWriteLock;
/**
* Concern that helps EntityStores do concurrent modification checks.
- * <p/>
+ * <p>
* It caches the versions of state that it loads, and forgets them when
* the state is committed. For normal operation this means that it does
* not have to go down to the underlying store to get the current version.
* Whenever there is a concurrent modification the store will most likely
* have to check with the underlying store what the current version is.
+ * </p>
*/
public abstract class ConcurrentModificationCheckConcern
extends ConcernOf<EntityStore>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/spi/src/main/java/org/qi4j/spi/entitystore/EntityStoreUnitOfWork.java
----------------------------------------------------------------------
diff --git a/core/spi/src/main/java/org/qi4j/spi/entitystore/EntityStoreUnitOfWork.java b/core/spi/src/main/java/org/qi4j/spi/entitystore/EntityStoreUnitOfWork.java
index 2cb005f..21655cd 100644
--- a/core/spi/src/main/java/org/qi4j/spi/entitystore/EntityStoreUnitOfWork.java
+++ b/core/spi/src/main/java/org/qi4j/spi/entitystore/EntityStoreUnitOfWork.java
@@ -29,10 +29,10 @@ public interface EntityStoreUnitOfWork
/**
* Create new EntityState for a given identity.
- * <p/>
+ * <p>
* This should only create the EntityState and not insert it into any database, since that should occur during
* the {@link EntityStoreUnitOfWork#applyChanges()} call.
- *
+ * </p>
* @param anIdentity the identity of the entity
* @param entityDescriptor entity descriptor
*
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/spi/src/main/java/org/qi4j/spi/entitystore/helpers/MapEntityStore.java
----------------------------------------------------------------------
diff --git a/core/spi/src/main/java/org/qi4j/spi/entitystore/helpers/MapEntityStore.java b/core/spi/src/main/java/org/qi4j/spi/entitystore/helpers/MapEntityStore.java
index e044690..1b87f22 100644
--- a/core/spi/src/main/java/org/qi4j/spi/entitystore/helpers/MapEntityStore.java
+++ b/core/spi/src/main/java/org/qi4j/spi/entitystore/helpers/MapEntityStore.java
@@ -29,6 +29,7 @@ public interface MapEntityStore
{
/**
+ * @param entityReference The reference to the entity that we want to get.
* @return Entity state Reader
*/
Reader get( EntityReference entityReference )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/spi/src/main/java/org/qi4j/spi/value/ValueDeserializerAdapter.java
----------------------------------------------------------------------
diff --git a/core/spi/src/main/java/org/qi4j/spi/value/ValueDeserializerAdapter.java b/core/spi/src/main/java/org/qi4j/spi/value/ValueDeserializerAdapter.java
index 8d4a558..73056fe 100644
--- a/core/spi/src/main/java/org/qi4j/spi/value/ValueDeserializerAdapter.java
+++ b/core/spi/src/main/java/org/qi4j/spi/value/ValueDeserializerAdapter.java
@@ -84,7 +84,7 @@ import static org.qi4j.functional.Iterables.first;
* Some other Plain values are expected in given formats:
* </p>
* <ul>
- * <li>BigInteger and BigDecimal depends on ValueSerializer.{@link Options};</li>
+ * <li>BigInteger and BigDecimal depends on {@link org.qi4j.api.value.ValueSerializer.Options};</li>
* <li>Date as String in ISO-8601, {@literal @millis@} or {@literal /Date(..)} Microsoft format;</li>
* <li>DateTime (JodaTime) as a ISO-8601 String with optional timezone offset;</li>
* <li>LocalDateTime (JodaTime) as whatever {@link LocalDateTime#LocalDateTime(java.lang.Object)} accept as {@literal instant};</li>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jBaseTest.java
----------------------------------------------------------------------
diff --git a/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jBaseTest.java b/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jBaseTest.java
index 0d9652f..3c878a1 100644
--- a/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jBaseTest.java
+++ b/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jBaseTest.java
@@ -84,9 +84,9 @@ public abstract class AbstractQi4jBaseTest
/**
* This method is called when there was an AssemblyException in the creation of the Qi4j application model.
- * <p/>
+ * <p>
* Override this method to catch valid failures to place into satisfiedBy suites.
- *
+ * </p>
* @param exception the exception thrown.
*
* @throws org.qi4j.bootstrap.AssemblyException The default implementation of this method will simply re-throw the exception.
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jScenarioTest.java
----------------------------------------------------------------------
diff --git a/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jScenarioTest.java b/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jScenarioTest.java
index 13e0eb8..48e1f0b 100644
--- a/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jScenarioTest.java
+++ b/core/testsupport/src/main/java/org/qi4j/test/AbstractQi4jScenarioTest.java
@@ -97,13 +97,13 @@ public abstract class AbstractQi4jScenarioTest
/**
* This method is called when there was an AssemblyException in the creation of the Qi4j application model.
- * <p/>
+ * <p>
* Override this method to catch valid failures to place into satisfiedBy suites.
+ * </p>
*
* @param exception the exception thrown.
*
- * @throws org.qi4j.bootstrap.AssemblyException
- * The default implementation of this method will simply re-throw the exception.
+ * @throws org.qi4j.bootstrap.AssemblyException The default implementation of this method will simply re-throw the exception.
*/
static protected void assemblyException( AssemblyException exception )
throws AssemblyException
@@ -131,7 +131,9 @@ public abstract class AbstractQi4jScenarioTest
}
else
{
- throw new InternalError( "I have seen a case where a UoW is on the stack, but not opened. First is" + uow.usecase().name() );
+ throw new InternalError( "I have seen a case where a UoW is on the stack, but not opened. First is" + uow
+ .usecase()
+ .name() );
}
}
new Exception( "UnitOfWork not properly cleaned up" ).printStackTrace();
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/extensions/entitystore-file/src/main/java/org/qi4j/entitystore/file/FileEntityStoreConfiguration.java
----------------------------------------------------------------------
diff --git a/extensions/entitystore-file/src/main/java/org/qi4j/entitystore/file/FileEntityStoreConfiguration.java b/extensions/entitystore-file/src/main/java/org/qi4j/entitystore/file/FileEntityStoreConfiguration.java
index 5d51fc5..34395c0 100644
--- a/extensions/entitystore-file/src/main/java/org/qi4j/entitystore/file/FileEntityStoreConfiguration.java
+++ b/extensions/entitystore-file/src/main/java/org/qi4j/entitystore/file/FileEntityStoreConfiguration.java
@@ -17,7 +17,8 @@ public interface FileEntityStoreConfiguration
* The directory where the File Entity Store will be keep its persisted state.
* <p>
* Default: System.getProperty( "user.dir" ) + "/qi4j/filestore";
- * <br/>
+ * </p>
+ * <p>
* Ignored if the FileConfiguration service is found.
* </p>
* <p>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/extensions/entitystore-jdbm/src/main/java/org/qi4j/entitystore/jdbm/JdbmConfiguration.java
----------------------------------------------------------------------
diff --git a/extensions/entitystore-jdbm/src/main/java/org/qi4j/entitystore/jdbm/JdbmConfiguration.java b/extensions/entitystore-jdbm/src/main/java/org/qi4j/entitystore/jdbm/JdbmConfiguration.java
index 616e266..a50b3b5 100644
--- a/extensions/entitystore-jdbm/src/main/java/org/qi4j/entitystore/jdbm/JdbmConfiguration.java
+++ b/extensions/entitystore-jdbm/src/main/java/org/qi4j/entitystore/jdbm/JdbmConfiguration.java
@@ -31,9 +31,9 @@ public interface JdbmConfiguration
// END SNIPPET: config
/**
* The file where the JDBM data will be stored
- * <p/>
+ * <p>
* Default: System.getProperty( "user.dir" ) + "/qi4j/jdbmstore.data";
- *
+ * </p>
* @return path to data file relative to current path
*/
// START SNIPPET: config
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/extensions/entitystore-preferences/src/main/java/org/qi4j/entitystore/prefs/PreferencesEntityStoreService.java
----------------------------------------------------------------------
diff --git a/extensions/entitystore-preferences/src/main/java/org/qi4j/entitystore/prefs/PreferencesEntityStoreService.java b/extensions/entitystore-preferences/src/main/java/org/qi4j/entitystore/prefs/PreferencesEntityStoreService.java
index 3cdcfd1..b0958ff 100644
--- a/extensions/entitystore-preferences/src/main/java/org/qi4j/entitystore/prefs/PreferencesEntityStoreService.java
+++ b/extensions/entitystore-preferences/src/main/java/org/qi4j/entitystore/prefs/PreferencesEntityStoreService.java
@@ -24,21 +24,25 @@ import org.qi4j.spi.entitystore.EntityStore;
/**
* EntityStore backed by Preferences API.
- * <p/>
+ * <p>
* A root node is created in the System preferences, whose name
* is the same as the Application name (default:"Application").
- * <p/>
+ * </p>
+ * <p>
* Each entity is stored under its identity name.
- * <p/>
+ * </p>
+ * <p>
* Property types are converted to native Preferences API types
* as much as possible. All others will be serialized to a string using JSON.
- * <p/>
+ * </p>
+ * <p>
* Associations are stored as the identity of the referenced Entity, ManyAssociations are stored as multi-line strings
* (one identity per line), and NamedAssociations are stored as multi-line strings (one name on a line, identity on the
* next line).
- * <p/>
+ * </p>
+ * <p>
* The main use of the EntityStore is for storage of ConfigurationComposites for ServiceComposites.
- *
+ * </p>
* @see org.qi4j.api.service.ServiceComposite
* @see org.qi4j.api.configuration.Configuration
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/extensions/indexing-sql/src/main/java/org/qi4j/index/sql/SQLIndexingEngineService.java
----------------------------------------------------------------------
diff --git a/extensions/indexing-sql/src/main/java/org/qi4j/index/sql/SQLIndexingEngineService.java b/extensions/indexing-sql/src/main/java/org/qi4j/index/sql/SQLIndexingEngineService.java
index 49c59e8..ad0c2b1 100644
--- a/extensions/indexing-sql/src/main/java/org/qi4j/index/sql/SQLIndexingEngineService.java
+++ b/extensions/indexing-sql/src/main/java/org/qi4j/index/sql/SQLIndexingEngineService.java
@@ -26,11 +26,12 @@ import org.qi4j.spi.query.EntityFinder;
/**
* This is actual service responsible of managing indexing and queries and creating database structure.
- * <p/>
+ * <p>
* The reason why all these components are in one single service is that they all require some data about
* the database structure. Rather than exposing all of that data publicly to be available via another service,
* it is stored in a state-style private mixin. Thus all the database-related data is available only to this
* service, and no one else.
+ * </p>
*/
@Mixins( {
SQLEntityFinder.class,
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmHistory.java
----------------------------------------------------------------------
diff --git a/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmHistory.java b/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmHistory.java
index ff54abb..9aea62e 100644
--- a/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmHistory.java
+++ b/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmHistory.java
@@ -29,7 +29,6 @@ import org.qi4j.api.property.Property;
* AlarmPoint system <i>should</i> implement <code>AlarmHistory</code> classes to
* record the events of an <code>AlarmPoint</code>.
*
- * @author Niclas Hedhman
*/
@Mixins( AlarmHistory.AlarmHistoryMixin.class )
public interface AlarmHistory
@@ -98,7 +97,8 @@ public interface AlarmHistory
* <code>activate();
* acknowledge();
* deactivate();
- * </code></pre>, the Map contains <table>
+ * </code></pre>, the Map contains
+ * <table summary="Triggers">
* <tr><td>(String) activate</td><td>(Integer) 1</td></tr>
* <tr><td>(String) deactivate</td><td>(Integer) 1</td></tr>
* <tr><td>(String) acknowledge</td><td>(Integer) 1</td></tr>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmNameFormat.java
----------------------------------------------------------------------
diff --git a/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmNameFormat.java b/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmNameFormat.java
index 58e67d8..c37fdc7 100644
--- a/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmNameFormat.java
+++ b/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmNameFormat.java
@@ -36,8 +36,8 @@ import org.qi4j.api.constraint.Constraints;
*
* public interface ExpressiveAlarm extends AlarmPoint
* {
- * @AlarmNameFormat(minimumLength=25)
- * Property<String> systemName();
+ * @AlarmNameFormat(minimumLength=25)
+ * Property<String> systemName();
* }
* </code></pre>
* <p>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmPoint.java
----------------------------------------------------------------------
diff --git a/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmPoint.java b/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmPoint.java
index 398ae30..81b98fd 100644
--- a/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmPoint.java
+++ b/libraries/alarm/src/main/java/org/qi4j/library/alarm/AlarmPoint.java
@@ -51,7 +51,8 @@ import org.qi4j.api.property.Property;
* <i>acknowledge</i> and must be present in all standard systems and standard impl.
* </p>
* <p>
- * The basic usage looks like this;<code><pre>
+ * The basic usage looks like this;
+ * <pre><code>
* // Creation
* AlarmPoint ala1 = alarmService.createAlarm( "My AlarmPoint" );
* :
@@ -59,16 +60,22 @@ import org.qi4j.api.property.Property;
* // use
* if( alarmcondition ) // The condition should only detect transitions.
* ala1.trigger( this, "activate" );
- * </pre></code>
+ * </code></pre>
* <p>
* It is important to know that every call to <code>trigger()</code>
* will generate an AlarmEvent, so the <code>trigger()</code> should
* only be called when the standard condition changes. For this purpose, there is
* a convenience method, that will create/generate the <code>trigger</code>
* method calls when a boolean standard condition changes. The usage is fairly
- * simple. Example;<code><pre>
- * ala1.updateCondition( value > highlimit );
- * </pre></code>
+ * simple.
+ * </p>
+ * <p>
+ * Example;
+ * </p>
+ * <pre><code>
+ * ala1.updateCondition( value > highlimit );
+ * </code></pre>
+ * <p>
* It is possible to mix and match the usage of <code>updateCondition()</code>
* and <code>trigger()</code> methods without any concerns.
* </p>
@@ -76,12 +83,12 @@ import org.qi4j.api.property.Property;
* To create alarms with different AlarmModels, other than the
* default as shown above, you need to retrieve the AlarmModel that
* fulfill the needs required. This can be done in the following manner;
- * <code><pre>
+ * </p>
+ * <pre><code>
* AlarmModel[] impl = alarmService.getAlarmModelsAvailable();
* // selection algorithm
* AlarmPoint ala2 = impl[selected].createAlarm( "My AlarmPoint" );
- * </pre></code>
- * </p>
+ * </code></pre>
* <p>
* The default AlarmModel can be changed by a call to the
* <code>AlarmSystem.setDefaultAlarmModel()</code> and
@@ -96,12 +103,9 @@ import org.qi4j.api.property.Property;
* for the pre-defined AlarmPoint behaviours, and the others for the rest of
* the Alarms.
* </p>
- *
- * @author Niclas Hedhman
*/
public interface AlarmPoint
{
-
String STATUS_NORMAL = "Normal";
String STATUS_ACTIVATED = "Activated";
String STATUS_DEACTIVATED = "Deactivated";
@@ -144,10 +148,12 @@ public interface AlarmPoint
/**
* Activates an AlarmPoint.
* <p>
- * Convinience method for:<pre>
- * trigger( "activate" );
- * </pre>
+ * Convenience method for:
* </p>
+ * <pre><code>
+ * trigger( "activate" );
+ * </code>
+ * </pre>
*/
void activate();
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/alarm/src/main/java/org/qi4j/library/alarm/ExtendedAlarmModelService.java
----------------------------------------------------------------------
diff --git a/libraries/alarm/src/main/java/org/qi4j/library/alarm/ExtendedAlarmModelService.java b/libraries/alarm/src/main/java/org/qi4j/library/alarm/ExtendedAlarmModelService.java
index 227b35f..dbb764e 100644
--- a/libraries/alarm/src/main/java/org/qi4j/library/alarm/ExtendedAlarmModelService.java
+++ b/libraries/alarm/src/main/java/org/qi4j/library/alarm/ExtendedAlarmModelService.java
@@ -31,14 +31,12 @@ import org.qi4j.api.value.ValueBuilder;
import org.qi4j.api.value.ValueBuilderFactory;
/**
- * <p>
* The Standard Model is centered around the Normal, Activated, Acknowledged
* Deactivated, Reactivated, Blocked and Disabled states, and the triggers "activate", "deactivate",
* "acknowledge", "block", "unblock", "enable" and "disable". The following matrix details the
- * resulting grid;
- * <p>
- * <table>
- * <tr><th>Initial State</th>* <th>Trigger</th><th>Resulting State</th><th>Event Generated</th></tr>
+ * resulting grid.
+ * <table summary="Transitions">
+ * <tr><th>Initial State</th><th>Trigger</th><th>Resulting State</th><th>Event Generated</th></tr>
* <tr><td>Normal</td><td>activate</td><td>Activated</td><td>activation</td></tr>
* <tr><td>Normal</td><td>deactivate</td><td>Normal</td><td>-</td></tr>
* <tr><td>Normal</td><td>acknowledge</td><td>Normal</td><td>-</td></tr>
@@ -78,7 +76,6 @@ import org.qi4j.api.value.ValueBuilderFactory;
* <tr><td>Activated</td><td>enable</td><td>Activated</td><td>-</td></tr>
* <tr><td>Reactivated</td><td>enable</td><td>Reactivated</td><td>-</td></tr>
* <tr><td>Disabled</td><td>enable</td><td>Normal</td><td>enable</td></tr>
- *
* </table>
*/
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/alarm/src/main/java/org/qi4j/library/alarm/SimpleAlarmModelService.java
----------------------------------------------------------------------
diff --git a/libraries/alarm/src/main/java/org/qi4j/library/alarm/SimpleAlarmModelService.java b/libraries/alarm/src/main/java/org/qi4j/library/alarm/SimpleAlarmModelService.java
index 4f824ce..378709e 100644
--- a/libraries/alarm/src/main/java/org/qi4j/library/alarm/SimpleAlarmModelService.java
+++ b/libraries/alarm/src/main/java/org/qi4j/library/alarm/SimpleAlarmModelService.java
@@ -34,12 +34,10 @@ import org.qi4j.api.value.ValueBuilderFactory;
public interface SimpleAlarmModelService extends AlarmModel, ServiceComposite
{
/**
- * <p>
* The Simple AlarmPoint Model is centered around the Normal and Activated.
* The triggers "activate" and "deactivate". The following matrix details the
- * resulting grid;
- * <p>
- * <table>
+ * resulting grid.
+ * <table summary="Transitions">
* <tr><th>Initial State</th><th>Trigger</th><th>Resulting State</th><th>Event Generated</th></tr>
* <tr><td>Normal</td><td>activate</td><td>Activated</td><td>activation</td></tr>
* <tr><td>Normal</td><td>deactivate</td><td>Normal</td><td>-</td></tr>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/alarm/src/main/java/org/qi4j/library/alarm/StandardAlarmModelService.java
----------------------------------------------------------------------
diff --git a/libraries/alarm/src/main/java/org/qi4j/library/alarm/StandardAlarmModelService.java b/libraries/alarm/src/main/java/org/qi4j/library/alarm/StandardAlarmModelService.java
index 80c731f..1911398 100644
--- a/libraries/alarm/src/main/java/org/qi4j/library/alarm/StandardAlarmModelService.java
+++ b/libraries/alarm/src/main/java/org/qi4j/library/alarm/StandardAlarmModelService.java
@@ -31,12 +31,13 @@ import org.qi4j.api.value.ValueBuilder;
import org.qi4j.api.value.ValueBuilderFactory;
/**
- * <p>
* The Standard AlarmPoint Model is centered around the Normal, Activated, Acknowledged
* and Deactivated states, and the triggers "activate", "deactivate",
- * and "acknowledge". The following matrix details the resulting grid;
+ * and "acknowledge".
* <p>
- * <table>
+ * The following matrix details the resulting grid.
+ * </p>
+ * <table summary="Transitions">
* <tr><th>Initial State</th><th>Trigger</th><th>Resulting State</th><th>Event Generated</th></tr>
* <tr><td>Normal</td><td>activate</td><td>Activated</td><td>activation</td></tr>
* <tr><td>Normal</td><td>deactivate</td><td>Normal</td><td>-</td></tr>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/eventsourcing-rest/src/main/java/org/qi4j/library/eventsourcing/domain/rest/server/DomainEventSourceResource.java
----------------------------------------------------------------------
diff --git a/libraries/eventsourcing-rest/src/main/java/org/qi4j/library/eventsourcing/domain/rest/server/DomainEventSourceResource.java b/libraries/eventsourcing-rest/src/main/java/org/qi4j/library/eventsourcing/domain/rest/server/DomainEventSourceResource.java
index 29788c4..4c59747 100644
--- a/libraries/eventsourcing-rest/src/main/java/org/qi4j/library/eventsourcing/domain/rest/server/DomainEventSourceResource.java
+++ b/libraries/eventsourcing-rest/src/main/java/org/qi4j/library/eventsourcing/domain/rest/server/DomainEventSourceResource.java
@@ -43,13 +43,17 @@ import org.restlet.resource.ResourceException;
import static org.qi4j.functional.Iterables.iterable;
/**
- * Get events in various formats. The feed is paged, with one
+ * Get events in various formats.
+ * <p>
+ * The feed is paged, with one
* current set page, one working set page, and the rest being archive pages that never change. The links "next", "previous",
* "first" and "last" are used as expected per the Atom spec.
- * <p/>
+ * </p>
+ * <pre><code>
* / = current set of most recent events (event range: count-pagesize to count)
* /n,m = events from index n to index m. These are archive pages.
* /n = working set page, where n is the first event index to be presented
+ * </code></pre>>
*/
public class DomainEventSourceResource
extends Restlet
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/api/ApplicationEvent.java
----------------------------------------------------------------------
diff --git a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/api/ApplicationEvent.java b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/api/ApplicationEvent.java
index 038beb7..efd02d8 100644
--- a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/api/ApplicationEvent.java
+++ b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/api/ApplicationEvent.java
@@ -22,14 +22,19 @@ import org.qi4j.api.property.Property;
import org.qi4j.api.value.ValueComposite;
/**
- * Representation of an application-event. An application event is triggered by calling a method
+ * Representation of an application-event.
+ * <p>
+ * An application event is triggered by calling a method
* that is of the form:
- * <p/>
+ * </p>
+ * <pre><code>
* void someName(ApplicationEvent event, SomeParam param);
- * <p/>
+ * </code></pre>
+ * <p>
* The "event" argument should be invoked with null, as it will be created during
* the method call. If it is not null, then the method call is a replay of previously
* created events.
+ * </p>
*/
public interface ApplicationEvent
extends ValueComposite, Identity
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/ApplicationEventSource.java
----------------------------------------------------------------------
diff --git a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/ApplicationEventSource.java b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/ApplicationEventSource.java
index 3dd335e..bb47de2 100644
--- a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/ApplicationEventSource.java
+++ b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/ApplicationEventSource.java
@@ -26,21 +26,28 @@ import org.qi4j.library.eventsourcing.application.api.TransactionApplicationEven
public interface ApplicationEventSource
{
/**
- * Get list of event transactions after the given timestamp. If they are on the exact same timestamp, they will not be included.
- * <p/>
+ * Get list of event transactions after the given timestamp.
+ * <p>
+ * If they are on the exact same timestamp, they will not be included.
+ * </p>
+ * <p>
* The method uses the visitor pattern, so a visitor is sent in which is given each transaction, one at a time.
- *
+ * </p>
* @param afterTimestamp timestamp of transactions
*/
Input<TransactionApplicationEvents, IOException> transactionsAfter( long afterTimestamp, long maxTransactions );
/**
- * Get list of event transactions before the given timestamp. If they are on the exact same timestamp, they will not be included.
- * <p/>
+ * Get list of event transactions before the given timestamp.
+ * <p>
+ * If they are on the exact same timestamp, they will not be included.
+ * </p>
+ * <p>
* The method uses the visitor pattern, so a visitor is sent in which is given each transaction, one at a time.
- * <p/>
+ * </p>
+ * <p>
* The transactions are sent to the visitor with the latest transaction first, i.e. walking backwards in the stream.
- *
+ * </p>
* @param beforeTimestamp timestamp of transactions
*/
Input<TransactionApplicationEvents, IOException> transactionsBefore( long beforeTimestamp, long maxTransactions );
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/helper/ApplicationTransactionTracker.java
----------------------------------------------------------------------
diff --git a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/helper/ApplicationTransactionTracker.java b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/helper/ApplicationTransactionTracker.java
index 31600b7..17f04e2 100644
--- a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/helper/ApplicationTransactionTracker.java
+++ b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/application/source/helper/ApplicationTransactionTracker.java
@@ -28,14 +28,17 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Helper that enables a service to easily track transactions. Upon startup
- * the tracker will get all the transactions from the store since the last
+ * Helper that enables a service to easily track transactions.
+ * <p>
+ * Upon startup the tracker will get all the transactions from the store since the last
* check, and delegate them to the given Output. It will also register itself
* with the store so that it can get continuous updates.
- * <p/>
+ * </p>
+ * <p>
* Then, as transactions come in from the store, they will be processed in real-time.
* If a transaction is successfully handled the configuration of the service, which must
* extend DomainEventTrackerConfiguration, will update the marker for the last successfully handled transaction.
+ * </p>
*/
public class ApplicationTransactionTracker<ReceiverThrowableType extends Throwable>
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/api/DomainEventValue.java
----------------------------------------------------------------------
diff --git a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/api/DomainEventValue.java b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/api/DomainEventValue.java
index 61e537f..cf03741 100644
--- a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/api/DomainEventValue.java
+++ b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/api/DomainEventValue.java
@@ -21,11 +21,13 @@ import org.qi4j.api.property.Property;
import org.qi4j.api.value.ValueComposite;
/**
- * Representation of a domain-event. An event is triggered by calling a method
- * that is of the form:
- * <p/>
+ * Representation of a domain-event.
+ * <p>An event is triggered by calling a method that is of the form:
+ * </p>
+ * <pre><code>
* @DomainEvent
* void someName(SomeParam param, AnotherParam param2);
+ * </code></pre>
*
*/
public interface DomainEventValue
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/EventSource.java
----------------------------------------------------------------------
diff --git a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/EventSource.java b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/EventSource.java
index 1bfc707..e025b3f 100644
--- a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/EventSource.java
+++ b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/EventSource.java
@@ -27,8 +27,10 @@ import org.qi4j.library.eventsourcing.domain.api.UnitOfWorkDomainEventsValue;
public interface EventSource
{
/**
- * Get list of UnitOfWorkDomainEventsValue after the given offset. To get the first set of events, use 0 as offset parameter to get events from the start.
- * <p/>
+ * Get list of UnitOfWorkDomainEventsValue after the given offset.
+ * <p>
+ * To get the first set of events, use 0 as offset parameter to get events from the start.
+ * </p>
*
* @param offset where in the list of events to start
* @param limit maximum number of events returned
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/helper/DomainEventTracker.java
----------------------------------------------------------------------
diff --git a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/helper/DomainEventTracker.java b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/helper/DomainEventTracker.java
index 5b8d63a..4673dfc 100644
--- a/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/helper/DomainEventTracker.java
+++ b/libraries/eventsourcing/src/main/java/org/qi4j/library/eventsourcing/domain/source/helper/DomainEventTracker.java
@@ -28,14 +28,18 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Helper that enables a service to easily track transactions. Upon startup
+ * Helper that enables a service to easily track transactions.
+ * <p>
+ * Upon startup
* the tracker will get all the transactions from the store since the last
* check, and delegate them to the given Output. It will also register itself
* with the store so that it can get continuous updates.
- * <p/>
+ * </p>
+ * <p>
* Then, as transactions come in from the store, they will be processed in real-time.
* If a transaction is successfully handled the configuration of the service, which must
* extend DomainEventTrackerConfiguration, will update the marker for the last successfully handled transaction.
+ * </p>
*/
public class DomainEventTracker
implements Runnable, UnitOfWorkEventsListener
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/fileconfig/src/main/java/org/qi4j/library/fileconfig/FileConfiguration.java
----------------------------------------------------------------------
diff --git a/libraries/fileconfig/src/main/java/org/qi4j/library/fileconfig/FileConfiguration.java b/libraries/fileconfig/src/main/java/org/qi4j/library/fileconfig/FileConfiguration.java
index 24f099a..17d4d9c 100644
--- a/libraries/fileconfig/src/main/java/org/qi4j/library/fileconfig/FileConfiguration.java
+++ b/libraries/fileconfig/src/main/java/org/qi4j/library/fileconfig/FileConfiguration.java
@@ -28,7 +28,8 @@ import java.io.File;
* <p>
* You can override defaults by adding org.qi4j.library.fileconfig.FileConfiguration_OS.properties files to your
* classpath where OS is one of win, mac or unix.
- * <br/>
+ * </p>
+ * <p>
* You can also override all properties definitions at assembly time by setting a FileConfigurationOverride object
* as meta info of this service.
* </p>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/http/src/main/java/org/qi4j/library/http/SecureJettyConfiguration.java
----------------------------------------------------------------------
diff --git a/libraries/http/src/main/java/org/qi4j/library/http/SecureJettyConfiguration.java b/libraries/http/src/main/java/org/qi4j/library/http/SecureJettyConfiguration.java
index 9fcfd7e..ea26830 100644
--- a/libraries/http/src/main/java/org/qi4j/library/http/SecureJettyConfiguration.java
+++ b/libraries/http/src/main/java/org/qi4j/library/http/SecureJettyConfiguration.java
@@ -153,14 +153,14 @@ public interface SecureJettyConfiguration
/**
* If the {@link SecureJettyService} certificate MUST be PKIX validated.
*
- * <p/><b>IMPORTANT:</b>
+ * <p><b>IMPORTANT:</b></p>
* <ul>
* <li>Server certificate validation do not use the configured truststore but the one of the JVM.</li>
* <li>Server certificates validation behavior depends on CRL and OCSP related configuration properties.</li>
* </ul>
- * <p/>
+ * <p>
* Defaults to false.
- *
+ * </p>
* @return If the {@link SecureJettyService} certificate MUST be PKIX validated.
*/
@UseDefaults
@@ -169,14 +169,14 @@ public interface SecureJettyConfiguration
/**
* If client certificates PKIX validation MUST use either CRL or OCSP.
*
- * <p/><b>IMPORTANT:</b>
+ * <p><b>IMPORTANT:</b></p>
* <ul>
* <li>Peer certificates validation use the configured truststore if present, the one of the JVM if not.</li>
* <li>Peer certificates validation behavior depends on CRL and OCSP related configuration properties.</li>
* </ul>
- * <p/>
+ * <p>
* Defaults to false.
- *
+ * </p>
* @return If client certificates PKIX validation MUST use either CRL or OCSP.
*/
@UseDefaults
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/invocation-cache/src/main/java/org/qi4j/library/invocationcache/ReturnCachedValueOnExceptionConcern.java
----------------------------------------------------------------------
diff --git a/libraries/invocation-cache/src/main/java/org/qi4j/library/invocationcache/ReturnCachedValueOnExceptionConcern.java b/libraries/invocation-cache/src/main/java/org/qi4j/library/invocationcache/ReturnCachedValueOnExceptionConcern.java
index fa8d68d..400baf5 100644
--- a/libraries/invocation-cache/src/main/java/org/qi4j/library/invocationcache/ReturnCachedValueOnExceptionConcern.java
+++ b/libraries/invocation-cache/src/main/java/org/qi4j/library/invocationcache/ReturnCachedValueOnExceptionConcern.java
@@ -26,8 +26,9 @@ import org.qi4j.api.injection.scope.This;
/**
* Return value of @Cached calls on exceptions.
- * <p/>
+ * <p>
* If an Exception occurs, try to reuse a previous result. Don't do anything on Throwables.
+ * </p>
*/
@AppliesTo( Cached.class )
public class ReturnCachedValueOnExceptionConcern
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/jmx/src/main/java/org/qi4j/library/jmx/JMXConnectorService.java
----------------------------------------------------------------------
diff --git a/libraries/jmx/src/main/java/org/qi4j/library/jmx/JMXConnectorService.java b/libraries/jmx/src/main/java/org/qi4j/library/jmx/JMXConnectorService.java
index 4e7a24b..0d41a4f 100644
--- a/libraries/jmx/src/main/java/org/qi4j/library/jmx/JMXConnectorService.java
+++ b/libraries/jmx/src/main/java/org/qi4j/library/jmx/JMXConnectorService.java
@@ -36,11 +36,15 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * This service starts a JMX RMI connector. It also creates an RMI-registry
+ * This service starts a JMX RMI connector.
+ * <p>
+ * It also creates an RMI-registry
* to register the connector. The service is configured by changing the
* settings in the JMXConnectorConfiguration.
- * <p/>
+ * </p>
+ * <p>
* Authentication is done with an optional username+password in the configuration.
+ * </p>
*/
@Mixins(JMXConnectorService.JmxConnectorMixin.class)
@Activators( JMXConnectorService.Activator.class )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/lang-beanshell/src/main/java/org/qi4j/lang/beanshell/BeanShellMixin.java
----------------------------------------------------------------------
diff --git a/libraries/lang-beanshell/src/main/java/org/qi4j/lang/beanshell/BeanShellMixin.java b/libraries/lang-beanshell/src/main/java/org/qi4j/lang/beanshell/BeanShellMixin.java
index f47aea3..a276605 100644
--- a/libraries/lang-beanshell/src/main/java/org/qi4j/lang/beanshell/BeanShellMixin.java
+++ b/libraries/lang-beanshell/src/main/java/org/qi4j/lang/beanshell/BeanShellMixin.java
@@ -41,9 +41,12 @@ import org.qi4j.library.scripting.ScriptReloadable;
* Each method in an interface is declared by a BeanShell method
* in a file located in classpath with the name "<interface>.bsh",
* where the interface name includes the package, and has "." replaced with "/".
- * <p/>
+ * <p>
* Example:
+ * </p>
+ * <p>
* org/qi4j/samples/hello/domain/HelloWorldSpeaker.bsh
+ * </p>
*/
@AppliesTo( BeanShellMixin.AppliesTo.class )
public class BeanShellMixin
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/lang-groovy/src/main/java/org/qi4j/lang/groovy/GroovyMixin.java
----------------------------------------------------------------------
diff --git a/libraries/lang-groovy/src/main/java/org/qi4j/lang/groovy/GroovyMixin.java b/libraries/lang-groovy/src/main/java/org/qi4j/lang/groovy/GroovyMixin.java
index 787c083..dd15683 100644
--- a/libraries/lang-groovy/src/main/java/org/qi4j/lang/groovy/GroovyMixin.java
+++ b/libraries/lang-groovy/src/main/java/org/qi4j/lang/groovy/GroovyMixin.java
@@ -42,10 +42,13 @@ import org.qi4j.io.Outputs;
* using Groovy. Each method in an interface is declared by a Groovy method
* in a file located in classpath with the name "<interface>.groovy",
* where the interface name includes the package, and has "." replaced with "/".
- * <p/>
+ * <p>
* Example:
+ * </p>
+ * <pre><code>
* org/qi4j/samples/hello/domain/HelloWorldSpeaker.groovy
* org/qi4j/samples/hello/domain/HelloWorldSpeaker.sayAgain.groovy
+ * </code></pre>
*
*/
@AppliesTo( GroovyMixin.AppliesTo.class )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/lang-javascript/src/main/java/org/qi4j/lang/javascript/JavaScriptMixin.java
----------------------------------------------------------------------
diff --git a/libraries/lang-javascript/src/main/java/org/qi4j/lang/javascript/JavaScriptMixin.java b/libraries/lang-javascript/src/main/java/org/qi4j/lang/javascript/JavaScriptMixin.java
index c48c208..f924f89 100644
--- a/libraries/lang-javascript/src/main/java/org/qi4j/lang/javascript/JavaScriptMixin.java
+++ b/libraries/lang-javascript/src/main/java/org/qi4j/lang/javascript/JavaScriptMixin.java
@@ -32,9 +32,12 @@ import org.qi4j.library.scripting.ScriptReloadable;
* using Rhino. Each method in an interface is declared as a JS function
* in a file located in classpath with the name "<interface>.<method>.js",
* where the interface name includes the package, and has "." replaced with "/".
- * <p/>
+ * <p>
* Example:
+ * </p>
+ * <pre><code>
* org/qi4j/samples/hello/domain/HelloWorldSpeaker.say.js
+ * </code></pre>
*/
@AppliesTo( JavaScriptMixin.AppliesTo.class )
public class JavaScriptMixin
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/lang-jruby/src/main/java/org/qi4j/lang/jruby/JRubyMixin.java
----------------------------------------------------------------------
diff --git a/libraries/lang-jruby/src/main/java/org/qi4j/lang/jruby/JRubyMixin.java b/libraries/lang-jruby/src/main/java/org/qi4j/lang/jruby/JRubyMixin.java
index 682d99f..c36d7f6 100644
--- a/libraries/lang-jruby/src/main/java/org/qi4j/lang/jruby/JRubyMixin.java
+++ b/libraries/lang-jruby/src/main/java/org/qi4j/lang/jruby/JRubyMixin.java
@@ -41,9 +41,12 @@ import org.qi4j.library.scripting.ScriptReloadable;
* using JRuby. Each method in an interface is declared by a Ruby method
* in a file located in classpath with the name "<interface>.rb",
* where the interface name includes the package, and has "." replaced with "/".
- * <p/>
+ * <p>
* Example:
+ * </p>
+ * <pre><code>
* org/qi4j/samples/hello/domain/HelloWorldSpeaker.rb
+ * </code></pre>
*/
@AppliesTo( JRubyMixin.AppliesTo.class )
public class JRubyMixin
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/logging/src/main/java/org/qi4j/logging/trace/Trace.java
----------------------------------------------------------------------
diff --git a/libraries/logging/src/main/java/org/qi4j/logging/trace/Trace.java b/libraries/logging/src/main/java/org/qi4j/logging/trace/Trace.java
index 02ae647..c56eeb0 100644
--- a/libraries/logging/src/main/java/org/qi4j/logging/trace/Trace.java
+++ b/libraries/logging/src/main/java/org/qi4j/logging/trace/Trace.java
@@ -17,19 +17,24 @@
*/
package org.qi4j.logging.trace;
-import java.lang.annotation.*;
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
import org.qi4j.api.injection.InjectionScope;
/**
* The Trace annotation is to indicate which methods should be traced when tracing is enabled.
- * <p/>
+ * <p>
* The <i>level</i> of the Trace indicates the <i>threshold level</i> that the <code>Tracer</code> instance must be set
* to, to enable tracing. If the <i>threshold level</i> of the <code>Tracer</code> instance is equal to or higher than
* the <i>level</i> of the <code>Trace</code> annotation the method will be traced.
* </p>
- * <p/>
+ * <p>
* The <code>Trace</code> annotation will only be used for <code>TraceConcern</code> and not if the
* all encompassing <code>TraceAllConcern</code> is used.
+ * </p>
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.METHOD } )
@@ -47,7 +52,7 @@ public @interface Trace
/**
* The value is the threshold level required to enable the tracing.
- * <p/>
+ * <p>
* If the Trace level is set to 100 (default), it is required that the
* Tracer (retrieved from the LogService) used is set to 100 or higher.
* </p>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceAllConcern.java
----------------------------------------------------------------------
diff --git a/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceAllConcern.java b/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceAllConcern.java
index 332506f..f09cb3f 100644
--- a/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceAllConcern.java
+++ b/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceAllConcern.java
@@ -25,11 +25,11 @@ import org.qi4j.api.injection.scope.This;
/**
* The TraceAllConcern will call the traceEntry(), traceExit() and traceException() methods in the
* Tracer instance associated with the CompositeType that the TraceAllConcern is part of.
- * <p/>
+ * <p>
* The Trace paradigm is all about tracking the entry and exit (both normal and exceptional ones)
* of methods.
* </p>
- * <p/>
+ * <p>
* The main difference to the <code>TraceConcern</code> is that this concern is not associated with
* the <code>@Trace</code> annotation, and all methods in the interfaces will be traced, unless
* the LogService has turned off tracing.
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceConcern.java
----------------------------------------------------------------------
diff --git a/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceConcern.java b/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceConcern.java
index 89fba15..00ac950 100644
--- a/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceConcern.java
+++ b/libraries/logging/src/main/java/org/qi4j/logging/trace/TraceConcern.java
@@ -26,7 +26,7 @@ import org.qi4j.api.injection.scope.This;
/**
* The TraceConcern will call the traceEntry(), traceExit() and traceException() methods in the
* Tracer instance associated with the CompositeType that the TraceConcern is part of.
- * <p/>
+ * <p>
* The Trace paradigm is all about tracking the entry and exit (both normal and exceptional ones)
* of methods. The TraceConcern will be added to all methods that declares the <code>@Trace</code>
* annotation, with an optional <i>level</i> argument. The <i>level</i> is the threshold of the
@@ -34,9 +34,10 @@ import org.qi4j.api.injection.scope.This;
* must be equal or higher than the <i>level</i> set in the <code>@Trace</code> annotation of the
* method.
* </p>
- * <p/>
- * If the <i>priority</p> of the <code>Tracer</code> is set to OFF (Integer.MIN_VALUE) then no
+ * <p>
+ * If the <i>priority</i> of the <code>Tracer</code> is set to OFF (Integer.MIN_VALUE) then no
* tracing will happen.
+ * </p>
*/
@AppliesTo( Trace.class )
public final class TraceConcern extends AbstractTraceConcern
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/osgi/src/main/java/org/qi4j/library/osgi/FallbackStrategy.java
----------------------------------------------------------------------
diff --git a/libraries/osgi/src/main/java/org/qi4j/library/osgi/FallbackStrategy.java b/libraries/osgi/src/main/java/org/qi4j/library/osgi/FallbackStrategy.java
index 2796c69..a725db2 100644
--- a/libraries/osgi/src/main/java/org/qi4j/library/osgi/FallbackStrategy.java
+++ b/libraries/osgi/src/main/java/org/qi4j/library/osgi/FallbackStrategy.java
@@ -15,13 +15,13 @@ import org.osgi.framework.ServiceReference;
* The fallback strategy is invoked when the OSGi service is not available and a method call is invoked.
* <p>
* The FallbackStrategy is declared on the {@link OSGiServiceImporter} service declaration, like;
- * <code><pre>
+ * <pre><code>
* FallbackStrategy strategy = new MyStrategy();
* module.services( OSGiServiceImporter.class )
* .identifiedBy( "osgi" )
* .setMetaInfo( bundleContext )
* .setMetaInfo( strategy );
- * </pre></code>
+ * </code></pre>
*/
public interface FallbackStrategy {
Object invoke(final ServiceReference reference, Method method, Object... args);
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/rest-client/src/main/java/org/qi4j/library/rest/client/api/ErrorHandler.java
----------------------------------------------------------------------
diff --git a/libraries/rest-client/src/main/java/org/qi4j/library/rest/client/api/ErrorHandler.java b/libraries/rest-client/src/main/java/org/qi4j/library/rest/client/api/ErrorHandler.java
index 1e39f62..e7ffb73 100644
--- a/libraries/rest-client/src/main/java/org/qi4j/library/rest/client/api/ErrorHandler.java
+++ b/libraries/rest-client/src/main/java/org/qi4j/library/rest/client/api/ErrorHandler.java
@@ -10,7 +10,7 @@ import org.restlet.data.Status;
import org.restlet.resource.ResourceException;
/**
- * Implements a chained list of specification->handler. Add the most specific handlers first, and the most generic last.
+ * Implements a chained list of specification->handler. Add the most specific handlers first, and the most generic last.
*/
public class ErrorHandler
implements ResponseHandler
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/rest-server/src/main/java/org/qi4j/library/rest/server/api/constraint/InteractionValidation.java
----------------------------------------------------------------------
diff --git a/libraries/rest-server/src/main/java/org/qi4j/library/rest/server/api/constraint/InteractionValidation.java b/libraries/rest-server/src/main/java/org/qi4j/library/rest/server/api/constraint/InteractionValidation.java
index b20b302..3739a22 100644
--- a/libraries/rest-server/src/main/java/org/qi4j/library/rest/server/api/constraint/InteractionValidation.java
+++ b/libraries/rest-server/src/main/java/org/qi4j/library/rest/server/api/constraint/InteractionValidation.java
@@ -19,29 +19,36 @@ package org.qi4j.library.rest.server.api.constraint;
/**
* Interface that resources can implement to achieve custom validation
- * of whether an interaction is valid or not. If the logic only applies for one
+ * of whether an interaction is valid or not.
+ * <p>
+ * If the logic only applies for one
* method it is usually better to use this instead of creating a new annotation for it.
- * <p/>
+ * </p>
+ * <p>
* This is triggered by annotating the method that should be validated like so:
+ * </p>
* <pre><code>
*
* @RequiresValid("xyz") public void xyz()
* {...}
- * <p/>
+ *
* </code></pre>
+ * <p>
* This causes isValid("xyz") to be called. The isValid()
* method can use the name to determine which set of logic is to be applied. Typically the provided
* string will correspond to the name of the interaction, but this is not strictly necessary. It is
* possible to combine several annotations on one method, if desired:
+ * </p>
* <pre><code>
*
* @RequiresValid("allowed") @RequiresValid("officehours")
* public void xyz()
* {...}
* </code></pre>
- * <p/>
+ * <p>
* The validation occurs both when a Resource is computed for the resource as a whole, and when an actual
* invocation of an interaction is made.
+ * </p>
*/
public interface InteractionValidation
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/rest/src/main/java/org/qi4j/library/rest/admin/EntitiesResource.java
----------------------------------------------------------------------
diff --git a/libraries/rest/src/main/java/org/qi4j/library/rest/admin/EntitiesResource.java b/libraries/rest/src/main/java/org/qi4j/library/rest/admin/EntitiesResource.java
index c515013..b643178 100644
--- a/libraries/rest/src/main/java/org/qi4j/library/rest/admin/EntitiesResource.java
+++ b/libraries/rest/src/main/java/org/qi4j/library/rest/admin/EntitiesResource.java
@@ -43,8 +43,9 @@ import org.restlet.resource.ServerResource;
/**
* Listing of all Entities.
- * <p/>
+ * <p>
* Mapped to /entity
+ * </p>
*/
public class EntitiesResource
extends ServerResource
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/scheduler/src/main/java/org/qi4j/library/scheduler/Scheduler.java
----------------------------------------------------------------------
diff --git a/libraries/scheduler/src/main/java/org/qi4j/library/scheduler/Scheduler.java b/libraries/scheduler/src/main/java/org/qi4j/library/scheduler/Scheduler.java
index 1b30045..5052055 100644
--- a/libraries/scheduler/src/main/java/org/qi4j/library/scheduler/Scheduler.java
+++ b/libraries/scheduler/src/main/java/org/qi4j/library/scheduler/Scheduler.java
@@ -40,7 +40,7 @@ import static org.qi4j.api.unitofwork.concern.UnitOfWorkPropagation.Propagation.
*
* By default, a {@link Schedule} is not durable. In other words, it do not survive an {@link Application} restart.
* To make a {@link Schedule} durable, set it's durable property to true once its scheduled.
- * Durable {@link Schedule}s that have no future run are removed by {@link SchedulerGarbageCollector}.
+ * Durable {@link Schedule}s that have no future run are removed by {@code SchedulerGarbageCollector} (not implemented?).
*/
@Concerns( UnitOfWorkConcern.class )
public interface Scheduler
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/spring/src/main/java/org/qi4j/library/spring/bootstrap/Qi4jApplicationBootstrap.java
----------------------------------------------------------------------
diff --git a/libraries/spring/src/main/java/org/qi4j/library/spring/bootstrap/Qi4jApplicationBootstrap.java b/libraries/spring/src/main/java/org/qi4j/library/spring/bootstrap/Qi4jApplicationBootstrap.java
index 1145ef5..02ca11f 100644
--- a/libraries/spring/src/main/java/org/qi4j/library/spring/bootstrap/Qi4jApplicationBootstrap.java
+++ b/libraries/spring/src/main/java/org/qi4j/library/spring/bootstrap/Qi4jApplicationBootstrap.java
@@ -23,8 +23,9 @@ import org.springframework.context.ApplicationContextAware;
/**
* Run a Qi4j Application as a Spring Bean and export its Services to Spring.
- *
+ * <p>
* Steps to export Qi4j service:
+ * </p>
* <ul>
* <li>Create spring BeanFactory service of qi4j services to export.</li>
* <li>Create a class that extends {@link Qi4jApplicationBootstrap}.</li>
@@ -32,32 +33,33 @@ import org.springframework.context.ApplicationContextAware;
* <li>Assemble qi4j application by implementing #assemble method.</li>
* <li>Sets the identity of bean factory service. This identity is the spring
* bean name.</li>
- * <li>Declare qi4j bootstrap in spring xml application context. <br/>
+ * <li>Declare qi4j bootstrap in spring xml application context. </li>
*
- * <pre>
- * <?xml version="1.0" encoding="UTF-8"?><br/>
+ * <pre><code>
+ * <?xml version="1.0" encoding="UTF-8"?>
+ *
* <beans xmlns="http://www.springframework.org/schema/beans"
* xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
* xmlns:qi4j="http://www.qi4j.org/schema/qi4j/spring"
* xsi:schemaLocation="
* http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
* http://www.qi4j.org/schema/qi4j/spring http://www.qi4j.org/schema/qi4j/spring/spring-0.5.xsd">
- * <br/>
+ *
* <!-- class that implements Qi4jApplicationBootstrap -->
- * <br/>
+ *
* <qi4j:bootstrap class="org.qi4j.library.spring.bootstrap.Qi4jTestBootstrap"/>
- * <br/>
+ *
* <bean id="commentServiceHolder" class="org.qi4j.library.spring.bootstrap.CommentServiceHolder">
- * <p/>
+ *
* <constructor-arg ref="commentService"/> <!-- Reference qi4j comment service -->
- * <br/>
+ *
* </bean>
- * </pre>
+ * </code></pre>
* </li>
* </ul>
- * <p/>
* <p>
* <b>Importing Spring beans as services</b><br/>
+ * </p>
* <ol>
* <li>Application bootstrap class must implement interface
* {@link ApplicationContextAware}.</li>
@@ -65,11 +67,10 @@ import org.springframework.context.ApplicationContextAware;
* {@link ModuleAssembly#importedServices(Class...)}.</li>
* <li>Set concrete Spring bean as meta-data of the imported service.</li>
* </ol>
- * </p>
- *
+ * <p>
* Look at org.qi4j.library.spring.bootstrap.Qi4jExportServiceTest for sample
* implementation.
- *
+ * </p>
*/
public abstract class Qi4jApplicationBootstrap
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/sql/src/main/java/org/qi4j/library/sql/common/SQLConfiguration.java
----------------------------------------------------------------------
diff --git a/libraries/sql/src/main/java/org/qi4j/library/sql/common/SQLConfiguration.java b/libraries/sql/src/main/java/org/qi4j/library/sql/common/SQLConfiguration.java
index a49167a..e03fc7d 100644
--- a/libraries/sql/src/main/java/org/qi4j/library/sql/common/SQLConfiguration.java
+++ b/libraries/sql/src/main/java/org/qi4j/library/sql/common/SQLConfiguration.java
@@ -19,7 +19,7 @@ import org.qi4j.api.configuration.ConfigurationComposite;
import org.qi4j.api.property.Property;
/**
- * Typical configuration for service, which uses a {@link DataSource} as connection to SQL
+ * Typical configuration for service, which uses a {@link javax.sql.DataSource} as connection to SQL
* database, and given schema name as schema to create tables in.
*/
public interface SQLConfiguration
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/libraries/uowfile/src/main/java/org/qi4j/library/uowfile/singular/HasUoWFile.java
----------------------------------------------------------------------
diff --git a/libraries/uowfile/src/main/java/org/qi4j/library/uowfile/singular/HasUoWFile.java b/libraries/uowfile/src/main/java/org/qi4j/library/uowfile/singular/HasUoWFile.java
index 074312c..e0df50e 100644
--- a/libraries/uowfile/src/main/java/org/qi4j/library/uowfile/singular/HasUoWFile.java
+++ b/libraries/uowfile/src/main/java/org/qi4j/library/uowfile/singular/HasUoWFile.java
@@ -30,6 +30,7 @@ public interface HasUoWFile
{
/**
* IMPORTANT Use this {@link File} inside read-only {@link UnitOfWork}s only
+ * @return The file that is attached.
*/
File attachedFile();
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/samples/dci-cargo/dcisample_b/src/main/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/WicketQi4jApplication.java
----------------------------------------------------------------------
diff --git a/samples/dci-cargo/dcisample_b/src/main/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/WicketQi4jApplication.java b/samples/dci-cargo/dcisample_b/src/main/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/WicketQi4jApplication.java
index 8397cf8..1057bc6 100644
--- a/samples/dci-cargo/dcisample_b/src/main/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/WicketQi4jApplication.java
+++ b/samples/dci-cargo/dcisample_b/src/main/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/WicketQi4jApplication.java
@@ -75,11 +75,11 @@ public class WicketQi4jApplication
*
* If you like, you can also override this method in the custom application class and simply
* return an instance of YourAssembler:
- * <code><pre>
+ * <pre><code>
* @Override protected ApplicationAssembler getAssembler() {
* return new YourAssemblerInAnyPath();
* }
- * </pre></code>
+ * </code></pre>
*/
protected ApplicationAssembler getAssembler()
throws Exception
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/samples/dci-cargo/dcisample_b/src/test/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/testing/ExpectedException.java
----------------------------------------------------------------------
diff --git a/samples/dci-cargo/dcisample_b/src/test/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/testing/ExpectedException.java b/samples/dci-cargo/dcisample_b/src/test/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/testing/ExpectedException.java
index 496b6d7..568d750 100644
--- a/samples/dci-cargo/dcisample_b/src/test/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/testing/ExpectedException.java
+++ b/samples/dci-cargo/dcisample_b/src/test/java/org/qi4j/sample/dcicargo/sample_b/infrastructure/testing/ExpectedException.java
@@ -22,19 +22,30 @@ import org.junit.runner.Description;
import org.junit.runners.model.Statement;
/**
- * ExpectedException
- *
+ * ExpectedException.
+ * <p>
* Wrapper of {@link org.junit.rules.ExpectedException} in order to provide custom
* expected exception one-liners for convenience.
- *
+ * </p>
+ * <p>
* If you're checking certain DomainSpecificException often, you could wrap it here too...
- *
- * {@see http://alexruiz.developerblogs.com/?p=1530}
- *
+ * </p>
+ * <p>
+ * See <a href="http://alexruiz.developerblogs.com/?p=1530">http://alexruiz.developerblogs.com/?p=1530</a>
+ * </p>
+ * <p>
* NOTE!
+ * </p>
+ * <p>
* 1. the check for the expected exception must be immediately above the code that is expected to throw such exception
+ * </p>
+ * <p>
* 2. the line of code that is expected to throw an exception should be the last line in the test method
- * {@see http://java.dzone.com/articles/unexpected-behavior-junits}
+ * </p>
+ * <p>
+ * See <a href="http://java.dzone.com/articles/unexpected-behavior-junits">http://java.dzone.com/articles/unexpected-behavior-junits</a>
+ * </p>
+ * <p>
*/
public class ExpectedException implements TestRule
{
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext.java
----------------------------------------------------------------------
diff --git a/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext.java b/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext.java
index 1cfe255..3902a19 100644
--- a/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext.java
+++ b/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext.java
@@ -25,9 +25,9 @@ import org.qi4j.dci.moneytransfer.rolemap.CreditorRolemap;
/**
* Context for paying bills from an account to a list of creditor accounts.
- * <p/>
- * Roles are defined within the context
- * A RoleMap lists what Roles an entity can play.
+ * <p>
+ * Roles are defined within the context. A RoleMap lists what Roles an entity can play.
+ * </p>
*/
public class PayBillsContext
{
@@ -47,26 +47,37 @@ public class PayBillsContext
/**
* The SourceAccountRole orchestrates the Pay Bills use case interactions.
- * <p/>
+ * <p>
* Code matches the use case text carefully (see references below).
- * <p/>
+ * </p>
+ * <p>
* Pay Bills use case scenario:
- * <p/>
- * 1) Bank finds creditors (could be a use case scenario in itself)
- * 2) Bank calculates the amount owed to creditors
- * 3) Bank verifies sufficient funds
- * 4) Bank transfer money to each creditor
- * <p/>
+ * </p>
+ * <ol>
+ * <li> Bank finds creditors (could be a use case scenario in itself)</li>
+ * <li> Bank calculates the amount owed to creditors</li>
+ * <li>Bank verifies sufficient funds</li>
+ * <li>Bank transfer money to each creditor</li>
+ * </ol>
+ *
+ * <p>
* Algorithm (steps to implement the scenario):
- * <p/>
+ * </p>
+ * <p>
* 1a) Source Account finds list of creditors
- * <p/>
+ * </p>
+ * <p>
* 2a) Source Account loops creditors to find the sum owed
- * <p/>
+ * </p>
+ * <p>
* 3a) Source Account verifies that its current balance is greater than the sum owed, and throws an exception if not
- * <p/>
+ * </p>
+ * <p>
* 4a) Source Account loops creditors
+ * </p>
+ * <p>
* 4b) Make a MoneyTransfer of the amount owed to each creditor
+ * </p>
*/
@Mixins( SourceAccountRole.Mixin.class )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext2.java
----------------------------------------------------------------------
diff --git a/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext2.java b/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext2.java
index e442978..c4030ba 100644
--- a/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext2.java
+++ b/samples/dci/src/main/java/org/qi4j/dci/moneytransfer/context/PayBillsContext2.java
@@ -22,9 +22,10 @@ import org.qi4j.dci.moneytransfer.domain.data.BalanceData;
/**
* Context for paying bills from an account to a list of creditor accounts.
- * <p/>
- * Roles are defined within the context
+ * <p>
+ * Roles are defined within the context.
* A RoleMap lists what Roles an entity can play.
+ * </p>
*/
public class PayBillsContext2
{
@@ -47,26 +48,42 @@ public class PayBillsContext2
/**
* The SourceAccountRole orchestrates the Pay Bills use case interactions.
- * <p/>
+ * <p>
* Code matches the use case text carefully (see references below).
- * <p/>
+ * </p>
+ * <p>
* Pay Bills use case scenario:
- * <p/>
+ * </p>
+ * <p>
* 1) Bank finds creditors (could be a use case scenario in itself)
+ * </p>
+ * <p>
* 2) Bank calculates the amount owed to creditors
+ * </p>
+ * <p>
* 3) Bank verifies sufficient funds
+ * </p>
+ * <p>
* 4) Bank transfer money to each creditor
- * <p/>
+ * </p>
+ * <p>
* Algorithm (steps to implement the scenario):
- * <p/>
+ * </p>
+ * <p>
+ * <p>
* 1a) Source Account finds list of creditors
- * <p/>
+ * </p>
+ * <p>
* 2a) Source Account loops creditors to find the sum owed
- * <p/>
+ * </p>
+ * <p>
* 3a) Source Account verifies that its current balance is greater than the sum owed, and throws an exception if not
- * <p/>
+ * </p>
+ * <p>
* 4a) Source Account loops creditors
+ * <p>
* 4b) Make a MoneyTransfer of the amount owed to each creditor
+ * </p>
*/
class SourceAccountRole
extends Role<BalanceData>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/samples/dddsample2/src/main/java/org/qi4j/samples/cargo/app1/model/cargo/Cargo.java
----------------------------------------------------------------------
diff --git a/samples/dddsample2/src/main/java/org/qi4j/samples/cargo/app1/model/cargo/Cargo.java b/samples/dddsample2/src/main/java/org/qi4j/samples/cargo/app1/model/cargo/Cargo.java
index 6ef80eb..4ca2a83 100755
--- a/samples/dddsample2/src/main/java/org/qi4j/samples/cargo/app1/model/cargo/Cargo.java
+++ b/samples/dddsample2/src/main/java/org/qi4j/samples/cargo/app1/model/cargo/Cargo.java
@@ -17,37 +17,45 @@ import org.qi4j.samples.cargo.app1.system.factories.DeliveryFactory;
/**
* A Cargo. This is the central class in the domain model,
* and it is the root of the Cargo-Itinerary-Leg-Delivery-RouteSpecification aggregate.
- * <p/>
+ * <p>
* A cargo is identified by a unique tracking id, and it always has an origin
* and a route specification. The life cycle of a cargo begins with the booking procedure,
* when the tracking id is assigned. During a (short) period of time, between booking
* and initial routing, the cargo has no itinerary.
- * <p/>
+ * </p>
+ * <p>
* The booking clerk requests a list of possible routes, matching the route specification,
* and assigns the cargo to one route. The route to which a cargo is assigned is described
* by an itinerary.
- * <p/>
+ * </p>
+ * <p>
* A cargo can be re-routed during transport, on demand of the customer, in which case
* a new route is specified for the cargo and a new route is requested. The old itinerary,
* being a value object, is discarded and a new one is attached.
- * <p/>
+ * </p>
+ * <p>
* It may also happen that a cargo is accidentally misrouted, which should notify the proper
* personnel and also trigger a re-routing procedure.
- * <p/>
+ * </p>
+ * <p>
* When a cargo is handled, the status of the delivery changes. Everything about the delivery
* of the cargo is contained in the Delivery value object, which is replaced whenever a cargo
* is handled by an asynchronous event triggered by the registration of the handling event.
- * <p/>
+ * </p>
+ * <p>
* The delivery can also be affected by routing changes, i.e. when a the route specification
* changes, or the cargo is assigned to a new route. In that case, the delivery update is performed
* synchronously within the cargo aggregate.
- * <p/>
+ * </p>
+ * <p>
* The life cycle of a cargo ends when the cargo is claimed by the customer.
- * <p/>
+ * </p>
+ * <p>
* The cargo aggregate, and the entre domain model, is built to solve the problem
* of booking and tracking cargo. All important business rules for determining whether
* or not a cargo is misdirected, what the current status of the cargo is (on board carrier,
* in port etc), are captured in this aggregate.
+ * </p>
*/
@Mixins( Cargo.CargoMixin.class )
public interface Cargo
@@ -81,16 +89,18 @@ public interface Cargo
/**
* Updates all aspects of the cargo aggregate status
* based on the current route specification, itinerary and handling of the cargo.
- * <p/>
+ * <p>
* When either of those three changes, i.e. when a new route is specified for the cargo,
* the cargo is assigned to a route or when the cargo is handled, the status must be
* re-calculated.
- * <p/>
+ * </p>
+ * <p>
* {@link RouteSpecification} and {@link Itinerary} are both inside the Cargo
* aggregate, so changes to them cause the status to be updated <b>synchronously</b>,
* but changes to the delivery history (when a cargo is handled) cause the status update
* to happen <b>asynchronously</b> since {@link org.qi4j.samples.cargo.app1.model.handling.HandlingEvent}
* is in a different aggregate.
+ * </p>
*
* @param handlingHistory handling history
*/
@@ -176,17 +186,18 @@ public interface Cargo
/**
* Updates all aspects of the cargo aggregate status
* based on the current route specification, itinerary and handling of the cargo.
- * <p/>
+ * <p>
* When either of those three changes, i.e. when a new route is specified for the cargo,
* the cargo is assigned to a route or when the cargo is handled, the status must be
* re-calculated.
- * <p/>
+ * </p>
+ * <p>
* {@link RouteSpecification} and {@link Itinerary} are both inside the Cargo
* aggregate, so changes to them cause the status to be updated <b>synchronously</b>,
* but changes to the delivery history (when a cargo is handled) cause the status update
* to happen <b>asynchronously</b> since
* {@link org.qi4j.samples.cargo.app1.model.handling.HandlingEvent} is in a different aggregate.
- *
+ * </p>
* @param handlingHistory handling history
*/
public void deriveDeliveryProgress( final HandlingHistory handlingHistory )
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/tests/performance/src/perf/java/org/qi4j/test/performance/entitystore/sql/PostgreSQLEntityStorePerformanceTest.java
----------------------------------------------------------------------
diff --git a/tests/performance/src/perf/java/org/qi4j/test/performance/entitystore/sql/PostgreSQLEntityStorePerformanceTest.java b/tests/performance/src/perf/java/org/qi4j/test/performance/entitystore/sql/PostgreSQLEntityStorePerformanceTest.java
index 3e85392..4291297 100644
--- a/tests/performance/src/perf/java/org/qi4j/test/performance/entitystore/sql/PostgreSQLEntityStorePerformanceTest.java
+++ b/tests/performance/src/perf/java/org/qi4j/test/performance/entitystore/sql/PostgreSQLEntityStorePerformanceTest.java
@@ -38,10 +38,12 @@ import org.qi4j.test.performance.entitystore.AbstractEntityStorePerformanceTest;
/**
* Performance test for PostgreSQLEntityStore.
- * <p/>
+ * <p>
* WARN This test is deactivated on purpose, please do not commit it activated.
- * <p/>
+ * </p>
+ * <p>
* To run it see PostgreSQLEntityStoreTest.
+ * </p>
*/
@Ignore( "WARN Tearing down this test is broken!" )
public class PostgreSQLEntityStorePerformanceTest
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/InvocationPerformanceTest.java
----------------------------------------------------------------------
diff --git a/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/InvocationPerformanceTest.java b/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/InvocationPerformanceTest.java
index 128dd9e..0e495ed 100644
--- a/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/InvocationPerformanceTest.java
+++ b/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/InvocationPerformanceTest.java
@@ -32,11 +32,13 @@ import org.qi4j.test.AbstractQi4jTest;
/**
* Invocation performance test.
- * <p/>
+ * <p>
* Don't forget to add VM value "-server" before running this test!
- * <p/>
+ * </p>
+ * <p>
* These tests are very sensitive to warmup of JVM, hence the duplication. Often the first round
* is only for getting the code jitted, and the second round is what you want to look at.
+ * </p>
*/
public class InvocationPerformanceTest
extends AbstractQi4jTest
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/PropertyMixinInvocationPerformanceTest.java
----------------------------------------------------------------------
diff --git a/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/PropertyMixinInvocationPerformanceTest.java b/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/PropertyMixinInvocationPerformanceTest.java
index b726623..6e38584 100644
--- a/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/PropertyMixinInvocationPerformanceTest.java
+++ b/tests/performance/src/perf/java/org/qi4j/test/performance/runtime/composite/PropertyMixinInvocationPerformanceTest.java
@@ -32,8 +32,9 @@ import org.qi4j.test.AbstractQi4jTest;
/**
* PropertyMixin invocation performance test.
- * <p/>
+ * <p>
* Don't forget to add VM value "-server" before running this test!
+ * </p>
*/
public class PropertyMixinInvocationPerformanceTest
extends AbstractQi4jTest
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/tools/envisage/src/main/java/org/qi4j/envisage/tree/TreeModelPane.java
----------------------------------------------------------------------
diff --git a/tools/envisage/src/main/java/org/qi4j/envisage/tree/TreeModelPane.java b/tools/envisage/src/main/java/org/qi4j/envisage/tree/TreeModelPane.java
index 7a34550..8d60aa8 100644
--- a/tools/envisage/src/main/java/org/qi4j/envisage/tree/TreeModelPane.java
+++ b/tools/envisage/src/main/java/org/qi4j/envisage/tree/TreeModelPane.java
@@ -38,9 +38,11 @@ import org.qi4j.tools.model.descriptor.ApplicationDetailDescriptor;
/**
* Application Model View as Swing Component.
- * It support 2 view:<br/>
- * - by Structure<br/>
- * - by Type<br/>
+ * It support 2 view:
+ * <pre><code>
+ * - by Structure
+ * - by Type
+ * </code></pre>
*/
public final class TreeModelPane
extends JPanel
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/package.html
----------------------------------------------------------------------
diff --git a/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/package.html b/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/package.html
index 04c0adf..7cd430b 100644
--- a/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/package.html
+++ b/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/package.html
@@ -6,16 +6,18 @@
Description of TransientComposite tutorials.
<h2>TransientComposite tutorials</h2>
-
+<p>
Throughout this set of tutorials it will be shown how to create and work with TransientComposites, which
is the basic element in Qi4j. We will refactor one HelloWorld class to take advantage of the various
features in Qi4j. These refactorings will make it easier to reuse parts of the class,
and introduce new features without having to change existing code. We will also look
at some of the existing classes, or Fragments, available in Qi4j that you can reuse
so that you don't have to write everything yourself.
-<p/>
+</p>
+<p>
Each tutorial in this series starts with the result from the previous tutorial, so you can
always look at the next tutorial step for guidance on what to do. Here are the steps:
+</p>
<ol>
<li>Interface refactoring</li>
<li>Creating a TransientComposite</li>
http://git-wip-us.apache.org/repos/asf/zest-qi4j/blob/3bf71dfe/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/tutorial1/package.html
----------------------------------------------------------------------
diff --git a/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/tutorial1/package.html b/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/tutorial1/package.html
index 408f76a..23d7725 100644
--- a/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/tutorial1/package.html
+++ b/tutorials/composites/src/main/java/org/qi4j/tutorials/composites/tutorial1/package.html
@@ -1,22 +1,26 @@
<body>
<h1>Tutorial 1 - Interface refactoring</h1>
-
+<p>
In this tutorial we start with a basic Java class, which when invoked will concatenate
the two properties "phrase" and "name". If invoked with the properties set to "Hello"
and "World" respectively it will hence return "Hello World".
-<p/>
+</p>
+<p>
Qi4j relies heavily on the use of interfaces. This makes it possible for an object
to externally implement a number of interfaces which internally is backed by a number
of Mixins, some of which you may have written yourself, and some of which may have been
reused. This also makes it easy to introduce Modifiers (aka "interceptors", aka "advice"),
which are Fragments which execute before and/or after the method on the Mixin is invoked.
-<p/>
+</p>
+<p>
The first task is therefore to refactor the code so that the method is implemented from an
interface instead. We should then also separate the state into one interface and the behaviour
into another. This will make things easier for us later when state and behaviour becomes
implemented by separate Mixins.
-<p/>
+</p>
+<p>
Steps for this tutorial:
+</p>
<ol>
<li>Refactor the class into interface and implementation.</li>
<li>Refactor the interface so that it extends one interface called HelloWorldBehaviour with behaviour and one called