AMQP-344 Use Spring Stylesheet For JDK 7 Javadocs

JIRA: https://jira.springsource.org/browse/AMQP-344

- Add reference to the stylesheet to build.gradle
- Change all `<pre>` tags to `<pre class="code">`
- Fix missing links
This commit is contained in:
Gary Russell
2013-12-10 11:29:06 -05:00
committed by Artem Bilan
parent e3618607ea
commit e33623b5d1
8 changed files with 42 additions and 21 deletions

View File

@@ -234,6 +234,7 @@ task api(type: Javadoc) {
options.author = true
options.header = rootProject.description
options.overview = 'src/api/overview.html'
options.stylesheetFile = file("src/api/stylesheet.css")
options.links(rootProject.ext.javadocLinks)
source subprojects.collect { project ->

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2010 the original author or authors.
* Copyright 2002-2013 the original author or authors.
*
* Licensed 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
@@ -23,7 +23,7 @@ import org.springframework.util.StringUtils;
* string that is used as a "reply to" address. There are however conventions in use and this class makes it easier to
* follow these conventions, which can be easily summarised as:
*
* <pre>
* <pre class="code">
* (exchangeType)://(exchange)/(routingKey)
* </pre>
*
@@ -49,7 +49,7 @@ public class Address {
/**
* Create an Address instance from a structured String in the form
*
* <pre>
* <pre class="code">
* (exchangeType)://(exchange)/(routingKey)
* </pre>
*
@@ -104,6 +104,7 @@ public class Address {
return this.routingKey;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder(this.exchangeType + "://" + this.exchangeName + "/");
if (StringUtils.hasText(this.routingKey)) {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2010 the original author or authors.
* Copyright 2002-2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -45,7 +45,7 @@ public interface Connection {
* Send an RPC request to the remote Erlang node. This convenience function
* creates the following message and sends it to 'rex' on the remote node:
*
* <pre>
* <pre class="code">
* { self, { call, Mod, Fun, Args, user } }
* </pre>
*
@@ -74,7 +74,7 @@ public interface Connection {
* function receives a message from the remote node, and expects it to have
* the following format:
*
* <pre>
* <pre class="code">
* { rex, Term }
* </pre>
*

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2010 the original author or authors.
* Copyright 2002-2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ package org.springframework.util.exec;
/**
* Destroys a process running for too long.
* For example:
* <pre>
* <pre class="code">
* ExecuteWatchdog watchdog = new ExecuteWatchdog(30000);
* Execute exec = new Execute(myloghandler, watchdog);
* exec.setCommandLine(mycmdline);
@@ -40,7 +40,7 @@ public class ExecuteWatchdog implements Runnable {
private Process process;
/** timeout duration. Once the process running time exceeds this it should be killed */
private int timeout;
private final int timeout;
/** say whether or not the watchog is currently monitoring a process */
private boolean watch = false;
@@ -105,6 +105,7 @@ public class ExecuteWatchdog implements Runnable {
/**
* Watches the process and terminates it, if it runs for too long.
*/
@Override
public synchronized void run() {
try {
// This isn't a Task, don't have a Project object to log.

View File

@@ -234,9 +234,9 @@ public class SimpleMessageListenerContainer extends AbstractMessageListenerConta
* @param maxConcurrentConsumers the maximum number of consumers.
*
* @see #setConcurrentConsumers(int)
* @see #setStartConsumerMinInterval(int)
* @see #stopConsumerMinInterval
* @see #setConsecutiveMessagesTrigger
* @see #setStartConsumerMinInterval(long)
* @see #setStopConsumerMinInterval(long)
* @see #setConsecutiveActiveTrigger(int)
* @see #setConsecutiveIdleTrigger(int)
*/
public void setMaxConcurrentConsumers(int maxConcurrentConsumers) {

View File

@@ -57,8 +57,7 @@ import org.springframework.amqp.rabbit.core.RabbitTemplate;
* </p>
* <p/>
*
* <pre>
* <code>
* <pre class="code">
* log4j.appender.amqp=org.springframework.amqp.log4j.AmqpAppender
* #-------------------------------
* ## Connection settings
@@ -105,7 +104,6 @@ import org.springframework.amqp.rabbit.core.RabbitTemplate;
* #-------------------------------
* log4j.appender.amqp.layout=org.apache.log4j.PatternLayout
* log4j.appender.amqp.layout.ConversionPattern=%d %p %t [%c] - <%m>%n
* </code>
* </pre>
*
* @author Jon Brisbin <jbrisbin@vmware.com>
@@ -458,6 +456,7 @@ public class AmqpAppender extends AppenderSkeleton {
events.add(new Event(event, event.getProperties()));
}
@Override
public void close() {
if (null != senderPool) {
senderPool.shutdownNow();
@@ -469,6 +468,7 @@ public class AmqpAppender extends AppenderSkeleton {
retryTimer.cancel();
}
@Override
public boolean requiresLayout() {
return true;
}
@@ -477,6 +477,7 @@ public class AmqpAppender extends AppenderSkeleton {
* Helper class to actually send LoggingEvents asynchronously.
*/
protected class EventSender implements Runnable {
@Override
public void run() {
try {
RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2013 the original author or authors.
*
* Licensed 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
@@ -22,6 +22,7 @@ import org.junit.internal.AssumptionViolatedException;
import org.junit.rules.TestWatchman;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.Statement;
import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
import org.springframework.amqp.rabbit.core.RabbitAdmin;
import org.springframework.util.StringUtils;
@@ -30,7 +31,7 @@ import org.springframework.util.StringUtils;
* <p>
* A rule that prevents integration tests from failing if the Rabbit broker application is not running or not
* accessible, with test federation configuration:
* <pre>
* <pre class="code">
* [
* {rabbitmq_federation,
* [
@@ -63,7 +64,7 @@ public class BrokerFederated extends TestWatchman {
private final boolean assumeOnline;
private int DEFAULT_PORT = BrokerTestUtils.getPort();
private final int DEFAULT_PORT = BrokerTestUtils.getPort();
private int port;

View File

@@ -1,3 +1,18 @@
/*
* Copyright 2002-2013 the original author or authors.
*
* Licensed 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.
*/
package org.springframework.amqp.rabbit.test;
import java.util.HashMap;
@@ -10,6 +25,7 @@ import org.junit.internal.AssumptionViolatedException;
import org.junit.rules.TestWatchman;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.Statement;
import org.springframework.amqp.core.Queue;
import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
import org.springframework.amqp.rabbit.core.RabbitAdmin;
@@ -22,7 +38,7 @@ import org.springframework.util.StringUtils;
* of a violated assumption (showing as successful). Usage:
* </p>
*
* <pre>
* <pre class="code">
* &#064;Rule
* public static BrokerRunning brokerIsRunning = BrokerRunning.isRunning();
*
@@ -58,9 +74,9 @@ public class BrokerRunning extends TestWatchman {
private final boolean purge;
private Queue[] queues;
private final Queue[] queues;
private int DEFAULT_PORT = BrokerTestUtils.getPort();
private final int DEFAULT_PORT = BrokerTestUtils.getPort();
private int port;