Author: davsclaus
Date: Tue Jan 3 09:41:22 2012
New Revision: 1226720
URL: http://svn.apache.org/viewvc?rev=1226720&view=rev
Log:
Polished javadoc and added new packages to javadoc maven goal
Added:
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/package.html
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/tracker/package.html
Removed:
camel/trunk/camel-core/src/main/java/org/apache/camel/package.html
Modified:
camel/trunk/camel-core/pom.xml
camel/trunk/camel-core/src/main/java/org/apache/camel/EndpointConfiguration.java
camel/trunk/camel-core/src/main/java/org/apache/camel/language/SpEL.java
camel/trunk/camel-core/src/main/java/org/apache/camel/language/tokenizer/package.html
camel/trunk/camel-core/src/main/java/org/apache/camel/main/MainSupport.java
camel/trunk/camel-core/src/main/java/org/apache/camel/management/mbean/package.html
camel/trunk/camel-core/src/main/java/org/apache/camel/model/config/package-info.java
camel/trunk/camel-core/src/main/java/org/apache/camel/model/loadbalancer/package-info.java
camel/trunk/camel-core/src/main/java/org/apache/camel/package-info.java
camel/trunk/camel-core/src/main/java/org/apache/camel/util/jsse/SSLContextParameters.java
Modified: camel/trunk/camel-core/pom.xml
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/pom.xml?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
--- camel/trunk/camel-core/pom.xml (original)
+++ camel/trunk/camel-core/pom.xml Tue Jan 3 09:41:22 2012
@@ -209,6 +209,14 @@
<packages>org.apache.camel.component.*</packages>
</group>
<group>
+ <title>Support APIs for implementors</title>
+ <packages>org.apache.camel.support.*</packages>
+ </group>
+ <group>
+ <title>Main class for running Camel standalone</title>
+ <packages>org.apache.camel.main.*</packages>
+ </group>
+ <group>
<title>Camel Runtime</title>
<packages>org.apache.camel.impl:org.apache.camel.impl.*</packages>
</group>
@@ -288,6 +296,14 @@
<packages>org.apache.camel.support</packages>
</group>
<group>
+ <title>Support APIs for implementors</title>
+ <packages>org.apache.camel.support.*</packages>
+ </group>
+ <group>
+ <title>Main class for running Camel standalone</title>
+ <packages>org.apache.camel.main.*</packages>
+ </group>
+ <group>
<title>Camel Runtime</title>
<packages>org.apache.camel.impl:org.apache.camel.impl.*</packages>
</group>
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/EndpointConfiguration.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/EndpointConfiguration.java?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/EndpointConfiguration.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/EndpointConfiguration.java
Tue Jan 3 09:41:22 2012
@@ -51,6 +51,7 @@ public interface EndpointConfiguration {
/**
* Gets the value of a particular parameter.
*
+ * @param name the parameter name
* @return the configuration URI.
*/
<T> T getParameter(String name);
@@ -58,13 +59,15 @@ public interface EndpointConfiguration {
/**
* Sets the value of a particular parameter.
*
- * @return the configuration URI.
+ * @param name the parameter name
+ * @param value the parameter value
*/
<T> void setParameter(String name, T value);
/**
- * Returns the formated configuration string of an {@link Endpoint}.
+ * Returns the formatted configuration string of an {@link Endpoint}.
*
+ * @param format the format
* @return the configuration URI in String format.
*/
String toUriString(UriFormat format);
Added:
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/package.html
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/package.html?rev=1226720&view=auto
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/package.html
(added)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/package.html
Tue Jan 3 09:41:22 2012
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+Camel OSGi Activator.
+
+</body>
+</html>
Added:
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/tracker/package.html
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/tracker/package.html?rev=1226720&view=auto
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/tracker/package.html
(added)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/osgi/tracker/package.html
Tue Jan 3 09:41:22 2012
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+Camel OSGi Bundle Tracker.
+
+</body>
+</html>
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/language/SpEL.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/language/SpEL.java?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/language/SpEL.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/language/SpEL.java
Tue Jan 3 09:41:22 2012
@@ -26,14 +26,12 @@ import java.lang.annotation.Target;
* An annotation for injection of Spring Expression Language (SpEL) expressions
* into method parameters, fields or properties.
*
- * In the context of Camel this annotation serves a similar purpose as
Spring's {@Value} annotation.
+ * In the context of Camel this annotation serves a similar purpose as
Spring's <tt>@Value</tt> annotation.
*/
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
@LanguageAnnotation(language = "spel")
public @interface SpEL {
-
String value();
-
}
\ No newline at end of file
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/language/tokenizer/package.html
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/language/tokenizer/package.html?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/language/tokenizer/package.html
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/language/tokenizer/package.html
Tue Jan 3 09:41:22 2012
@@ -19,7 +19,7 @@
</head>
<body>
-Camel Tokenizer language.
+Camel <a href="http://camel.apache.org/tokenizer";>Tokenizer</a> language.
</body>
</html>
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/main/MainSupport.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/main/MainSupport.java?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/main/MainSupport.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/main/MainSupport.java
Tue Jan 3 09:41:22 2012
@@ -353,10 +353,6 @@ public abstract class MainSupport extend
return answer;
}
- /**
- * Returns a {@link org.apache.camel.ProducerTemplate} from the Spring
{@link org.springframework.context.ApplicationContext} instances
- * or lazily creates a new one dynamically
- */
public ProducerTemplate getCamelTemplate() throws Exception {
if (camelTemplate == null) {
camelTemplate = findOrCreateCamelTemplate();
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/management/mbean/package.html
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/management/mbean/package.html?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/management/mbean/package.html
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/management/mbean/package.html
Tue Jan 3 09:41:22 2012
@@ -19,7 +19,7 @@
</head>
<body>
-Camel management JMX Mbeans
+Camel management JMX MBeans
</body>
</html>
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/model/config/package-info.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/model/config/package-info.java?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/model/config/package-info.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/model/config/package-info.java
Tue Jan 3 09:41:22 2012
@@ -16,7 +16,9 @@
*/
/**
- * Configuration for various EIP patterns
+ * The JAXB POJOs for various configurations for the
+ * <a href="http://camel.apache.org/xml-configuration.html";>XML
Configuration</a>
+ * of the routing rules.
*/
@javax.xml.bind.annotation.XmlSchema(namespace =
"http://camel.apache.org/schema/spring";, elementFormDefault =
javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
package org.apache.camel.model.config;
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/model/loadbalancer/package-info.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/model/loadbalancer/package-info.java?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/model/loadbalancer/package-info.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/model/loadbalancer/package-info.java
Tue Jan 3 09:41:22 2012
@@ -15,8 +15,11 @@
* limitations under the License.
*/
+
/**
- * The <a href="http://camel.apache.org/load-balancer.html";>Load Balancer</a>
EIP pattern
+ * The JAXB POJOs for the
+ * <a href="http://camel.apache.org/load-balancer.html";>Load Balancer</a> EIP
pattern for the
+ * <a href="http://camel.apache.org/xml-configuration.html";>XML
Configuration</a>.
*/
@javax.xml.bind.annotation.XmlSchema(namespace =
"http://camel.apache.org/schema/spring";, elementFormDefault =
javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
package org.apache.camel.model.loadbalancer;
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/package-info.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/package-info.java?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/package-info.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/package-info.java Tue
Jan 3 09:41:22 2012
@@ -16,9 +16,7 @@
*/
/**
- * The JAXB POJOs for the
- * <a href="http://camel.apache.org/xml-configuration.html";>XML
Configuration</a>
- * of the routing rules.
+ * The core Camel API.
*/
@javax.xml.bind.annotation.XmlSchema(namespace =
"http://camel.apache.org/schema/spring";, elementFormDefault =
javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
package org.apache.camel;
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/util/jsse/SSLContextParameters.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/util/jsse/SSLContextParameters.java?rev=1226720&r1=1226719&r2=1226720&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/util/jsse/SSLContextParameters.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/util/jsse/SSLContextParameters.java
Tue Jan 3 09:41:22 2012
@@ -129,7 +129,7 @@ public class SSLContextParameters extend
/**
* Sets the optional secure random configuration options to use for
- * constructing the {@link SecureRandom} used in the creation of an {@link
SSLContext].
+ * constructing the {@link SecureRandom} used in the creation of an {@link
SSLContext}.
*
* @param secureRandom the options or {@code null} to use the default
*/
