Commit 9ab886f4 authored by Phillip Webb's avatar Phillip Webb

Consistent javadoc "code" block formatting

Update javadoc to consistently use the "code" style with <pre> blocks.
Also include the latest spring-javadoc.css formatting file.

Fixes gh-332
parent b21f56a2
...@@ -56,6 +56,12 @@ ...@@ -56,6 +56,12 @@
<dependencySourceInclude>${project.groupId}:*</dependencySourceInclude> <dependencySourceInclude>${project.groupId}:*</dependencySourceInclude>
</dependencySourceIncludes> </dependencySourceIncludes>
<attach>false</attach> <attach>false</attach>
<quiet>true</quiet>
<stylesheetfile>${basedir}/src/main/javadoc/spring-javadoc.css</stylesheetfile>
<links>
<link>http://docs.spring.io/spring-framework/docs/4.0.x/javadoc-api/</link>
<link>http://docs.oracle.com/javase/7/docs/api/</link>
</links>
</configuration> </configuration>
</execution> </execution>
</executions> </executions>
......
This diff is collapsed.
...@@ -42,14 +42,14 @@ import org.springframework.core.io.ResourceLoader; ...@@ -42,14 +42,14 @@ import org.springframework.core.io.ResourceLoader;
* convenient fluent API and context hierarchy support. Simple example of a context * convenient fluent API and context hierarchy support. Simple example of a context
* hierarchy: * hierarchy:
* *
* <pre> * <pre class="code">
* new SpringApplicationBuilder(ParentConfig.class).child(ChildConfig.class).run(args); * new SpringApplicationBuilder(ParentConfig.class).child(ChildConfig.class).run(args);
* </pre> * </pre>
* *
* Another common use case is setting default arguments, e.g. active Spring profiles, to * Another common use case is setting default arguments, e.g. active Spring profiles, to
* set up the environment for an application: * set up the environment for an application:
* *
* <pre> * <pre class="code">
* new SpringApplicationBuilder(Application.class).profiles(&quot;server&quot;) * new SpringApplicationBuilder(Application.class).profiles(&quot;server&quot;)
* .defaultArgs(&quot;--transport=local&quot;).run(args); * .defaultArgs(&quot;--transport=local&quot;).run(args);
* </pre> * </pre>
......
...@@ -49,7 +49,7 @@ import org.springframework.util.StringUtils; ...@@ -49,7 +49,7 @@ import org.springframework.util.StringUtils;
* index, etc.), and VCAP_SERVICES is a hash of lists where the keys are service labels * index, etc.), and VCAP_SERVICES is a hash of lists where the keys are service labels
* and the values are lists of hashes of service instance meta data. Examples are: * and the values are lists of hashes of service instance meta data. Examples are:
* *
* <pre> * <pre class="code">
* VCAP_APPLICATION: {"instance_id":"2ce0ac627a6c8e47e936d829a3a47b5b","instance_index":0, * VCAP_APPLICATION: {"instance_id":"2ce0ac627a6c8e47e936d829a3a47b5b","instance_index":0,
* "version":"0138c4a6-2a73-416b-aca0-572c09f7ca53","name":"foo", * "version":"0138c4a6-2a73-416b-aca0-572c09f7ca53","name":"foo",
* "uris":["foo.cfapps.io"], ...} * "uris":["foo.cfapps.io"], ...}
...@@ -66,7 +66,7 @@ import org.springframework.util.StringUtils; ...@@ -66,7 +66,7 @@ import org.springframework.util.StringUtils;
* instance name (e.g. "mysql" in the example above), and value equal to that instances * instance name (e.g. "mysql" in the example above), and value equal to that instances
* properties, and then flattened in the same way. E.g. * properties, and then flattened in the same way. E.g.
* *
* <pre> * <pre class="code">
* vcap.application.instance_id: 2ce0ac627a6c8e47e936d829a3a47b5b * vcap.application.instance_id: 2ce0ac627a6c8e47e936d829a3a47b5b
* vcap.application.version: 0138c4a6-2a73-416b-aca0-572c09f7ca53 * vcap.application.version: 0138c4a6-2a73-416b-aca0-572c09f7ca53
* vcap.application.name: foo * vcap.application.name: foo
......
...@@ -31,7 +31,7 @@ import org.springframework.beans.factory.FactoryBean; ...@@ -31,7 +31,7 @@ import org.springframework.beans.factory.FactoryBean;
* is all entries with the same nested key of type Map at any depth are merged. For * is all entries with the same nested key of type Map at any depth are merged. For
* example: * example:
* *
* <pre> * <pre class="code">
* foo: * foo:
* bar: * bar:
* one: two * one: two
...@@ -41,7 +41,7 @@ import org.springframework.beans.factory.FactoryBean; ...@@ -41,7 +41,7 @@ import org.springframework.beans.factory.FactoryBean;
* *
* plus (later in the list) * plus (later in the list)
* *
* <pre> * <pre class="code">
* foo: * foo:
* bar: * bar:
* one: 2 * one: 2
...@@ -51,7 +51,7 @@ import org.springframework.beans.factory.FactoryBean; ...@@ -51,7 +51,7 @@ import org.springframework.beans.factory.FactoryBean;
* *
* results in an effecive input of * results in an effecive input of
* *
* <pre> * <pre class="code">
* foo: * foo:
* bar: * bar:
* one: 2 * one: 2
......
...@@ -54,7 +54,7 @@ public class YamlProcessor { ...@@ -54,7 +54,7 @@ public class YamlProcessor {
* documents in a YAML resource. In YAML documents are separated by * documents in a YAML resource. In YAML documents are separated by
* <code>---<code> lines, and each document is converted to properties before the match is made. E.g. * <code>---<code> lines, and each document is converted to properties before the match is made. E.g.
* *
* <pre> * <pre class="code">
* environment: dev * environment: dev
* url: http://dev.bar.com * url: http://dev.bar.com
* name: Developer Setup * name: Developer Setup
...@@ -67,7 +67,7 @@ public class YamlProcessor { ...@@ -67,7 +67,7 @@ public class YamlProcessor {
* when mapped with <code>documentMatchers = YamlProcessor.mapMatcher({"environment": "prod"})</code> * when mapped with <code>documentMatchers = YamlProcessor.mapMatcher({"environment": "prod"})</code>
* would end up as * would end up as
* *
* <pre> * <pre class="code">
* environment=prod * environment=prod
* url=http://foo.bar.com * url=http://foo.bar.com
* name=My Cool App * name=My Cool App
......
...@@ -28,7 +28,7 @@ import org.springframework.beans.factory.FactoryBean; ...@@ -28,7 +28,7 @@ import org.springframework.beans.factory.FactoryBean;
* The Properties created by this factory have nested paths for hierarchical objects, so * The Properties created by this factory have nested paths for hierarchical objects, so
* for instance this YAML * for instance this YAML
* *
* <pre> * <pre class="code">
* environments: * environments:
* dev: * dev:
* url: http://dev.bar.com * url: http://dev.bar.com
...@@ -40,7 +40,7 @@ import org.springframework.beans.factory.FactoryBean; ...@@ -40,7 +40,7 @@ import org.springframework.beans.factory.FactoryBean;
* *
* is transformed into these Properties: * is transformed into these Properties:
* *
* <pre> * <pre class="code">
* environments.dev.url=http://dev.bar.com * environments.dev.url=http://dev.bar.com
* environments.dev.name=Developer Setup * environments.dev.name=Developer Setup
* environments.prod.url=http://foo.bar.com * environments.prod.url=http://foo.bar.com
...@@ -50,7 +50,7 @@ import org.springframework.beans.factory.FactoryBean; ...@@ -50,7 +50,7 @@ import org.springframework.beans.factory.FactoryBean;
* Lists are represented as comma-separated values (useful for simple String values) and * Lists are represented as comma-separated values (useful for simple String values) and
* also as property keys with <code>[]</code> dereferencers, for example this YAML: * also as property keys with <code>[]</code> dereferencers, for example this YAML:
* *
* <pre> * <pre class="code">
* servers: * servers:
* - dev.bar.com * - dev.bar.com
* - foo.bar.com * - foo.bar.com
...@@ -58,7 +58,7 @@ import org.springframework.beans.factory.FactoryBean; ...@@ -58,7 +58,7 @@ import org.springframework.beans.factory.FactoryBean;
* *
* becomes java Properties like this: * becomes java Properties like this:
* *
* <pre> * <pre class="code">
* servers=dev.bar.com,foo.bar.com * servers=dev.bar.com,foo.bar.com
* servers[0]=dev.bar.com * servers[0]=dev.bar.com
* servers[1]=foo.bar.com * servers[1]=foo.bar.com
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment