zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-07-20 17:56:08 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add a task to compile javadoc across all packages (#597)

Browse source 
Also fixes various issues that prevent javadoc compliation.
This commit is contained in:
Lai Jiang 2020-05-27 10:33:46 -04:00 • committed by GitHub
parent 275b4b1cee
commit 02e43ab134
71 changed files with 236 additions and 249 deletions
Download patch file Download diff file Expand all files Collapse all files

4
prober/src/main/java/google/registry/monitoring/blackbox/ProbingSequence.java
View file

@ -33,8 +33,8 @@ import io.netty.channel.EventLoopGroup;
* <p>Inherits from {@link CircularList}, with element type of {@link ProbingStep} as the manner in
* which the sequence is carried out is similar to the {@link CircularList}. However, the {@link
* Builder} of {@link ProbingSequence} override {@link CircularList.AbstractBuilder} allowing for
* more customized flows, that are looped, but not necessarily entirely circular. Example: first ->
* second -> third -> fourth -> second -> third -> fourth -> second -> ...
* more customized flows, that are looped, but not necessarily entirely circular. Example: first
* -&gt; second -&gt; third -&gt; fourth -&gt; second -&gt; third -&gt; fourth -&gt; second -&gt;...
*
* <p>Created with {@link Builder} where we specify {@link EventLoopGroup}, {@link AbstractChannel}
* class type, then sequentially add in the {@link ProbingStep.Builder}s in order and mark which one

5
prober/src/main/java/google/registry/monitoring/blackbox/connection/ProbingAction.java
View file

@ -47,9 +47,8 @@ import org.joda.time.Duration;
/**
* AutoValue class that represents action generated by {@link ProbingStep}
*
* <p>Inherits from {@link Callable<ChannelFuture>}, as it has can be called to perform its
* specified task, and return the {@link ChannelFuture} that will be informed when the task has been
* completed
* <p>Inherits from {@link Callable}, as it has can be called to perform its specified task, and
* return the {@link ChannelFuture} that will be informed when the task has been completed
*
* <p>Is an immutable class, as it is comprised of the tools necessary for making a specific type of
* connection. It goes hand in hand with {@link Protocol}, which specifies the kind of overall

4
prober/src/main/java/google/registry/monitoring/blackbox/handler/ActionHandler.java
View file

@ -27,8 +27,8 @@ import io.netty.channel.SimpleChannelInboundHandler;
/**
* Superclass of all {@link io.netty.channel.ChannelHandler}s placed at end of channel pipeline
*
* <p>{@link ActionHandler} inherits from {@link SimpleChannelInboundHandler<InboundMessageType>},
* as it should only be passed in messages that implement the {@link InboundMessageType} interface.
* <p>{@link ActionHandler} inherits from {@link SimpleChannelInboundHandler}, as it should only be
* passed in messages that implement the {@link InboundMessageType} interface.
*
* <p>The {@link ActionHandler} skeleton exists for a few main purposes. First, it returns a {@link
* ChannelPromise}, which informs the {@link ProbingAction} in charge that a response has been read.

2
prober/src/main/java/google/registry/monitoring/blackbox/handler/WebWhoisActionHandler.java
View file

@ -40,7 +40,7 @@ import org.joda.time.Duration;
*
* <p>Main purpose is to verify {@link HttpResponseMessage} received is valid. If the response
* implies a redirection it follows the redirection until either an Error Response is received, or
* {@link HttpResponseStatus.OK} is received
* {@link HttpResponseStatus#OK} is received
*/
public class WebWhoisActionHandler extends ActionHandler {

5
prober/src/main/java/google/registry/monitoring/blackbox/message/EppMessage.java
View file

@ -209,8 +209,7 @@ public class EppMessage {
* @param xml the XML Document containing the EPP reponse to verify
* @param expressions a list of XPath expressions to query the document with.
* @param validate a boolean flag to control if schema validation occurs (useful for testing)
* @throws IOException if InputStream throws one
* @throws EppClientException if the EPP response cannot be read, parsed, or doesn't containing
* @throws FailureException if the EPP response cannot be read, parsed, or doesn't containing
* matching data specified in expressions
*/
protected static void verifyEppResponse(Document xml, List<String> expressions, boolean validate)
@ -309,7 +308,7 @@ public class EppMessage {
*
* @param responseBuffer the byte array to transform
* @return the resulting Document
* @throws EppClientException if the transform fails
* @throws FailureException if the transform fails
*/
public static Document byteArrayToXmlDoc(byte[] responseBuffer) throws FailureException {
Document xml;

2
prober/src/main/java/google/registry/monitoring/blackbox/message/EppRequestMessage.java
View file

@ -117,7 +117,7 @@ public class EppRequestMessage extends EppMessage implements OutboundMessageType
*
* @return the {@link ByteBuf} instance that stores the bytes representing the requisite EPP
* Request
* @throws EppClientException- On the occasion that the prober can't appropriately convert the EPP
* @throws EppClientException On the occasion that the prober can't appropriately convert the EPP
* XML document to a {@link ByteBuf}, the blame falls on the prober, not the server, so it
* throws an {@link EppClientException}, which is a subclass of the {@link
* UndeterminedStateException}.