Make javadoc <p> style guide compliant

This led to confusion for an open source contributor about how to format
code. We don't want to be like, "do as I say, not as I do."

https://google.github.io/styleguide/javaguide.html#s7.1.2-javadoc-paragraphs
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=122589700
This commit is contained in:
Justine Tunney 2016-05-17 18:56:33 -07:00
parent 4854f875b0
commit 6f4b059cc9
79 changed files with 395 additions and 386 deletions

View file

@ -35,8 +35,8 @@ public final class DateTimeParameter extends ParameterConverterValidator<DateTim
* Parser for DateTimes that permits only a restricted subset of ISO 8601 datetime syntax.
* The supported format is "YYYY-MM-DD'T'HH:MM:SS[.SSS]ZZ", i.e. there must be a complete date
* and at least hours, minutes, seconds, and time zone; milliseconds are optional.
* <p>
* We use this instead of the default {@link ISODateTimeFormat#dateTimeParser()} because that
*
* <p>We use this instead of the default {@link ISODateTimeFormat#dateTimeParser()} because that
* parser is very flexible and accepts date times with missing dates, missing dates, and various
* other unspecified fields that can lead to confusion and ambiguity.
*/

View file

@ -18,8 +18,8 @@ import java.util.logging.Level;
/**
* Java logging level CLI parameter converter/validator.
* <p>
* If Level were an enum then this wouldn't be needed since JCommander has built-in conversion
*
* <p>If Level were an enum then this wouldn't be needed since JCommander has built-in conversion
* support for enums, but Level is actually just a regular class with some static instances.
*/
public final class LoggingLevelParameter extends ParameterConverterValidator<Level> {

View file

@ -30,15 +30,16 @@ import java.util.Map;
/**
* Combined converter and validator class for transition list JCommander argument strings.
* <p>
* These strings have the form {@code <DateTime>=<T-str>,[<DateTime>=<T-str>]*} where
* {@code <T-str>} is a string that can be parsed into an instance of some value type {@code T},
* and the entire argument represents a series of timed transitions of some property taking on
* those values. This class converts such a string into an ImmutableSortedMap mapping DateTime to
* {@code T}. Validation and conversion share the same logic; validation is just done by attempting
*
* <p>These strings have the form {@code <DateTime>=<T-str>,[<DateTime>=<T-str>]*} where
* {@code <T-str>} is a string that can be parsed into an instance of some value type {@code T}, and
* the entire argument represents a series of timed transitions of some property taking on those
* values. This class converts such a string into an ImmutableSortedMap mapping DateTime to
* {@code T}. Validation and conversion share the same logic; validation is just done by attempting
* conversion and throwing exceptions if need be.
* <p>
* Subclasses must implement parseValue() to define how to parse {@code <T-str>} into a {@code T}.
*
* <p>Subclasses must implement parseValue() to define how to parse {@code <T-str>} into a
* {@code T}.
*
* @param <T> instance value type
*/