Author: luc
Date: Mon Oct 1 19:32:10 2012
New Revision: 1392550
URL: http://svn.apache.org/viewvc?rev=1392550&view=rev
Log:
Javadoc style.
Modified:
commons/sandbox/nabla/trunk/checkstyle.xml
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/caching/package-info.java
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/TrackingInterpreter.java
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/package-info.java
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/arithmetic/package-info.java
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/instructions/package-info.java
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/package-info.java
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/trimming/package-info.java
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/package-info.java
Modified: commons/sandbox/nabla/trunk/checkstyle.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/checkstyle.xml?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
--- commons/sandbox/nabla/trunk/checkstyle.xml (original)
+++ commons/sandbox/nabla/trunk/checkstyle.xml Mon Oct 1 19:32:10 2012
@@ -32,6 +32,10 @@
<property name="option" value="eol"/>
</module>
+ <!-- White space checking around specific tokens -->
+ <module name="NoWhitespaceAfter"/>
+ <module name="NoWhitespaceBefore"/>
+
<!-- No if/else/do/for/while without braces -->
<module name="NeedBraces"/>
@@ -50,7 +54,10 @@
<!-- Require field javadoc -->
<module name="JavadocVariable"/>
-
+
+ <!-- javadoc should be well written -->
+ <module name="JavadocStyle"/>
+
<!-- No public fields -->
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
@@ -100,6 +107,7 @@
<!-- no sysouts -->
<property name="format" value="System\.out\.println"/>
<property name="illegalPattern" value="true"/>
+ <property name="ignoreComments" value="true"/>
</module>
<!-- Authors should be in pom.xml file -->
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/caching/package-info.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/caching/package-info.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/caching/package-info.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/caching/package-info.java
Mon Oct 1 19:32:10 2012
@@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
- *Caching of already differentiated functions package
+ * Caching of already differentiated functions package.
*/
package org.apache.commons.nabla.caching;
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/TrackingInterpreter.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/TrackingInterpreter.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/TrackingInterpreter.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/TrackingInterpreter.java
Mon Oct 1 19:32:10 2012
@@ -86,10 +86,7 @@ public class TrackingInterpreter extends
return (type == null) ? TrackingValue.UNINITIALIZED_VALUE : new
TrackingValue(type);
}
- /** {@inheritDoc}
- * <p>
- * The implementation for this meth
- */
+ /** {@inheritDoc} */
@Override
public TrackingValue newOperation(final AbstractInsnNode insn) throws
AnalyzerException {
switch (insn.getOpcode()) {
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/package-info.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/package-info.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/package-info.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/analysis/package-info.java
Mon Oct 1 19:32:10 2012
@@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
- *Bytecode analysis and transformation package
+ * Bytecode analysis and transformation package.
*/
package org.apache.commons.nabla.forward.analysis;
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/arithmetic/package-info.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/arithmetic/package-info.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/arithmetic/package-info.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/arithmetic/package-info.java
Mon Oct 1 19:32:10 2012
@@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
- *Arithmetic operations transformers package
+ * Arithmetic operations transformers package.
*/
package org.apache.commons.nabla.forward.arithmetic;
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/instructions/package-info.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/instructions/package-info.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/instructions/package-info.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/instructions/package-info.java
Mon Oct 1 19:32:10 2012
@@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
- *General instructions transformers package
+ * General instructions transformers package.
*/
package org.apache.commons.nabla.forward.instructions;
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/package-info.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/package-info.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/package-info.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/package-info.java
Mon Oct 1 19:32:10 2012
@@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
- *Forward mode algorithmic differentiation package
+ * Forward mode algorithmic differentiation package.
*/
package org.apache.commons.nabla.forward;
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/trimming/package-info.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/trimming/package-info.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/trimming/package-info.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/forward/trimming/package-info.java
Mon Oct 1 19:32:10 2012
@@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
- *Bytecode special constructs handling package
+ * Bytecode special constructs handling package.
*/
package org.apache.commons.nabla.forward.trimming;
Modified:
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/package-info.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/package-info.java?rev=1392550&r1=1392549&r2=1392550&view=diff
==============================================================================
---
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/package-info.java
(original)
+++
commons/sandbox/nabla/trunk/src/main/java/org/apache/commons/nabla/package-info.java
Mon Oct 1 19:32:10 2012
@@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
- *Top-level package of the Apache commons-nabla library.
+ * Top-level package of the Apache commons-nabla library.
*/
package org.apache.commons.nabla;
