zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-05-12 22:38:16 +02:00
Code Issues Projects Releases Packages Wiki Activity

Make javadoc <p> style guide compliant

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

38
java/google/registry/xml/XmlTransformer.java
View file

@ -121,9 +121,9 @@ public class XmlTransformer {
/**
* Validates XML text against {@link #schema} without marshalling.
* <p>
* You must specify the XML class you expect to receive as the root element.
* Validation is performed in accordance with the hard-coded XML schemas.
*
* <p>You must specify the XML class you expect to receive as the root element. Validation is
* performed in accordance with the hard-coded XML schemas.
*
* @throws XmlException if XML input was invalid or root element doesn't match {@code expect}.
*/
@ -137,8 +137,8 @@ public class XmlTransformer {
/**
* Turns XML text into an object, validating against {@link #schema}.
* <p>
* You must specify the XML class you expect to receive as the root element. Validation is
*
* <p>You must specify the XML class you expect to receive as the root element. Validation is
* performed in accordance with the hard-coded XML schemas.
*
* @throws XmlException if failed to read from {@code bytes}, XML input is invalid, or root
@ -181,11 +181,11 @@ public class XmlTransformer {
/**
* Streams {@code root} without XML declaration, optionally validating against the schema.
* <p>
* The root object must be annotated with {@link javax.xml.bind.annotation.XmlRootElement}. If the
* validation parameter is set to {@link ValidationMode#STRICT} this method will verify that your
* object strictly conforms to {@link #schema}. Because the output is streamed,
* {@link XmlException} will most likely be thrown <i>after</i> output has been written.
*
* <p>The root object must be annotated with {@link javax.xml.bind.annotation.XmlRootElement}. If
* the validation parameter is set to {@link ValidationMode#STRICT} this method will verify that
* your object strictly conforms to {@link #schema}. Because the output is streamed, {@link
* XmlException} will most likely be thrown <i>after</i> output has been written.
*
* @param root the object to write
* @param writer to write the output to
@ -206,10 +206,10 @@ public class XmlTransformer {
/**
* Validates and streams {@code root} as formatted XML bytes with XML declaration.
* <p>
* The root object must be annotated with {@link javax.xml.bind.annotation.XmlRootElement}. If the
* validation parameter is set to {@link ValidationMode#STRICT} this method will verify that your
* object strictly conforms to {@link #schema}. Because the output is streamed,
*
* <p>The root object must be annotated with {@link javax.xml.bind.annotation.XmlRootElement}. If
* the validation parameter is set to {@link ValidationMode#STRICT} this method will verify that
* your object strictly conforms to {@link #schema}. Because the output is streamed,
* {@link XmlException} will most likely be thrown <i>after</i> output has been written.
*
* @param root the object to write
@ -233,11 +233,11 @@ public class XmlTransformer {
/**
* Validates and streams {@code root} as characters, always using strict validation.
* <p>
* The root object must be annotated with {@link javax.xml.bind.annotation.XmlRootElement}. This
* method will verify that your object strictly conforms to {@link #schema}. Because the output is
* streamed, {@link XmlException} will most likely be thrown <i>after</i> output has been
* written.
*
* <p>The root object must be annotated with {@link javax.xml.bind.annotation.XmlRootElement}.
* This method will verify that your object strictly conforms to {@link #schema}. Because the
* output is streamed, {@link XmlException} will most likely be thrown <i>after</i> output has
* been written.
*
* @param root the object to write
* @param result to write the output to