Migrate the documentation package to Java 11 (#729)

* Migrate the documentation package to Java 11

The old Doclet API is deprected and removed in Java 12. This commit
changes the documentation package to use the new recommended API.
However it is not a drop-in replacement and there are non-idiomatic
usages all over the place. I think it is eaiser to keep the current code
logic and kind of shoehorn in the new API than starting afresh as the
return on investment of a do-over is not great.

Also note that the docs package is disabled as of this commit because we
are still using Java 8 to compile which lacks the new API. Once we
switch our toolchains to Java 11 (but still compiling Java 8 bytecode)
we can re-enable this package.

TESTED=ran `./gradlew :docs:test` locally with the documentation package
enabled.
This commit is contained in:
Lai Jiang 2020-07-30 17:12:33 -04:00 committed by GitHub
parent a1f4e8b985
commit fba8af0485
11 changed files with 304 additions and 259 deletions

View file

@ -8,7 +8,6 @@ An EPP flow that checks whether a contact can be provisioned.
This flows can check the existence of multiple contacts simultaneously.
### Errors
* 2306
@ -20,7 +19,6 @@ This flows can check the existence of multiple contacts simultaneously.
An EPP flow that creates a new contact.
### Errors
* 2005
@ -43,7 +41,6 @@ as all existing domains must be checked for references to the host before the
deletion is allowed to proceed. A poll message will be written with the success
or failure message when the process is complete.
### Errors
* 2201
@ -67,7 +64,6 @@ contact's most recent transfer if it has ever been transferred. Any registrar
can see any contact's information, but the authInfo is only visible to the
registrar that owns the contact or to a registrar that already supplied it.
### Errors
* 2201
@ -87,7 +83,6 @@ default five days) after which the transfer is automatically approved. Within
that window, this flow allows the losing client to explicitly approve the
transfer request, which then becomes effective immediately.
### Errors
* 2201
@ -111,7 +106,6 @@ default five days) after which the transfer is automatically approved. Within
that window, this flow allows the gaining client to withdraw the transfer
request.
### Errors
* 2201
@ -137,7 +131,6 @@ authId) to see the status of a transfer, which may still be pending or may have
been approved, rejected, cancelled or implicitly approved by virtue of the
transfer period expiring.
### Errors
* 2002
@ -160,7 +153,6 @@ registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, this flow allows the losing client to reject the transfer request.
### Errors
* 2201
@ -184,7 +176,6 @@ default five days) after which the transfer is automatically approved. Within
that window, the transfer might be approved explicitly by the losing registrar
or rejected, and the gaining registrar can also cancel the transfer request.
### Errors
* 2002
@ -206,7 +197,6 @@ or rejected, and the gaining registrar can also cancel the transfer request.
An EPP flow that updates a contact.
### Errors
* 2004
@ -234,7 +224,6 @@ An EPP flow that checks whether a domain can be provisioned.
This flow also supports the EPP fee extension and can return pricing
information.
### Errors
* 2002
@ -273,7 +262,6 @@ information.
An EPP flow that checks whether domain labels are trademarked.
### Errors
* 2002
@ -294,7 +282,6 @@ An EPP flow that checks whether domain labels are trademarked.
An EPP flow that creates a new domain resource.
### Errors
* 2002
@ -391,7 +378,6 @@ An EPP flow that creates a new domain resource.
An EPP flow that deletes a domain.
### Errors
* 2002
@ -420,7 +406,6 @@ authInfo for the domain, will get a rich result with all of the domain's fields.
All other requests will be answered with a minimal result containing only basic
information about the domain.
### Errors
* 2004
@ -452,7 +437,6 @@ In practice this means it's impossible to request a ten year renewal, since that
will always cause the new registration to be longer than 10 years unless it
comes in at the exact millisecond that the domain would have expired.
### Errors
* 2003
@ -508,7 +492,6 @@ Restores cost a fixed restore fee plus a one year renewal fee for the domain.
The domain is restored to a single year expiration starting at the restore time,
regardless of what the original expiration time was.
### Errors
* 2002
@ -559,7 +542,6 @@ Datastore with timestamps such that they only would become active when the
transfer period passed. In this flow, those speculative objects are deleted and
replaced with new ones with the correct approval time.
### Errors
* 2201
@ -588,7 +570,6 @@ When the transfer was requested, poll messages and billing events were saved to
Datastore with timestamps such that they only would become active when the
transfer period passed. In this flow, those speculative objects are deleted.
### Errors
* 2201
@ -615,7 +596,6 @@ authId) to see the status of a transfer, which may still be pending or may have
been approved, rejected, cancelled or implicitly approved by virtue of the
transfer period expiring.
### Errors
* 2002
@ -642,7 +622,6 @@ When the transfer was requested, poll messages and billing events were saved to
Datastore with timestamps such that they only would become active when the
transfer period passed. In this flow, those speculative objects are deleted.
### Errors
* 2201
@ -674,7 +653,6 @@ the domain's transfer data, and on explicit approval, rejection or cancellation
of the request, they will be deleted (and in the approval case, replaced with
new ones with the correct approval time).
### Errors
* 2002
@ -729,7 +707,6 @@ applied by the superuser. As such, adding or removing these statuses incurs a
billing event. There will be only one charge per update, even if several such
statuses are updated at once.
### Errors
* 2003
@ -777,7 +754,6 @@ statuses are updated at once.
A flow for an Epp "hello".
### Errors
* 2001
@ -791,7 +767,6 @@ An EPP flow that checks whether a host can be provisioned.
This flows can check the existence of multiple hosts simultaneously.
### Errors
* 2306
@ -809,7 +784,6 @@ external hosts are all other hosts. Internal hosts must have at least one ip
address associated with them, whereas external hosts cannot have any. This flow
allows creating a host name, and if necessary enqueues tasks to update DNS.
### Errors
* 2003
@ -845,7 +819,6 @@ as all existing domains must be checked for references to the host before the
deletion is allowed to proceed. A poll message will be written with the success
or failure message when the process is complete.
### Errors
* 2005
@ -871,7 +844,6 @@ The returned information included IP addresses, if any, and details of the
host's most recent transfer if it has ever been transferred. Any registrar can
see the information for any host.
### Errors
* 2005
@ -898,7 +870,6 @@ simultaneously removed, and when it is renamed from external to internal at
least one must be added. If the host is renamed or IP addresses are added, tasks
are enqueued to update DNS accordingly.
### Errors
* 2004
@ -937,7 +908,6 @@ are enqueued to update DNS accordingly.
An EPP flow for login.
### Errors
* 2002
@ -969,7 +939,6 @@ An EPP flow for login.
An EPP flow for logout.
### Errors
* 2002
@ -986,7 +955,6 @@ Registrars refer to poll messages using an externally visible id generated by
Datastore once they are ACKed, whereas autorenew poll messages are simply marked
as read, and won't be delivered again until the next year of their recurrence.
### Errors
* 2003
@ -1011,7 +979,6 @@ speculative and could still be changed or rescinded) are ignored. The externally
visible id for the poll message that the registrar sees is generated by {@link
PollMessageExternalKeyConverter}.
### Errors
* 2005