Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Switch Javadoc <code>...</code> to {@code ...}

Browse Source 
Update Javadoc to use the {@code ...} syntax when possible.
This commit is contained in:
Phillip Webb
2015-06-05 10:10:34 -07:00
parent 6230d905c6
commit 7609c43685
32 changed files with 100 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java
View File

@@ -52,21 +52,21 @@ import org.springframework.boot.loader.util.SystemPropertyUtils;
* well-behaved OS-level services than a model based on executable jars.
* <p>
* Looks in various places for a properties file to extract loader settings, defaulting to
* <code>application.properties</code> either on the current classpath or in the current
* {@code application.properties} either on the current classpath or in the current
* working directory. The name of the properties file can be changed by setting a System
* property <code>loader.config.name</code> (e.g. <code>-Dloader.config.name=foo</code>
* will look for <code>foo.properties</code>. If that file doesn't exist then tries
* <code>loader.config.location</code> (with allowed prefixes <code>classpath:</code> and
* <code>file:</code> or any valid URL). Once that file is located turns it into
* property {@code loader.config.name} (e.g. {@code -Dloader.config.name=foo}
* will look for {@code foo.properties}. If that file doesn't exist then tries
* {@code loader.config.location} (with allowed prefixes {@code classpath:} and
* {@code file:} or any valid URL). Once that file is located turns it into
* Properties and extracts optional values (which can also be provided overridden as
* System properties in case the file doesn't exist):
* <ul>
* <li><code>loader.path</code>: a comma-separated list of directories to append to the
* <li>{@code loader.path}: a comma-separated list of directories to append to the
* classpath (containing file resources and/or nested archives in *.jar or *.zip).
* Defaults to <code>lib</code> (i.e. a directory in the current working directory)</li>
* <li><code>loader.main</code>: the main method to delegate execution to once the class
* Defaults to {@code lib} (i.e. a directory in the current working directory)</li>
* <li>{@code loader.main}: the main method to delegate execution to once the class
* loader is set up. No default, but will fall back to looking for a
* <code>Start-Class</code> in a <code>MANIFEST.MF</code>, if there is one in
* {@code Start-Class} in a {@code MANIFEST.MF}, if there is one in
* <code>${loader.home}/META-INF</code>.</li>
* </ul>
*
@@ -79,7 +79,7 @@ public class PropertiesLauncher extends Launcher {
/**
* Properties key for main class. As a manifest entry can also be specified as
* <code>Start-Class</code>.
* {@code Start-Class}.
*/
public static final String MAIN = "loader.main";

4
spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/util/SystemPropertyUtils.java
View File

@@ -167,8 +167,8 @@ public abstract class SystemPropertyUtils {
/**
* Search the System properties and environment variables for a value with the
* provided key. Environment variables in <code>UPPER_CASE</code> style are allowed
* where System properties would normally be <code>lower.case</code>.
* provided key. Environment variables in {@code UPPER_CASE} style are allowed
* where System properties would normally be {@code lower.case}.
* @param key the key to resolve
* @param defaultValue the default value
* @param text optional extra context for an error message if the key resolution fails