Improve JavaDoc formatting
@@ -35,22 +35,26 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
@Restricted(NoExternalUse.class)
public class UrlHelper {
/**
- * Authorize the {@code _} and {@code -} characters in *domain*
+ * Authorize the {@code _} and {@code -} characters in <strong>domain</strong>
* <p>
* Avoid {@code -} to be first or last, and {@code .} to be first (but can be last)
+ * <p>
*
- * Lenient version of
- * - https://tools.ietf.org/html/rfc952 GRAMMATICAL HOST TABLE SPECIFICATION
- * - https://www.ietf.org/rfc/rfc1034.txt 3.5
- * - https://www.ietf.org/rfc/rfc1738.txt 3.1, host
- * - https://tools.ietf.org/html/rfc1123 2.1
+ * Lenient version of: <ol>
+ * <li> <a href="https://tools.ietf.org/html/rfc952">RFC-952</a> GRAMMATICAL HOST TABLE SPECIFICATION</li>
+ * <li> <a href="https://www.ietf.org/rfc/rfc1034.txt">RFC-1034</a> 3.5</li>
+ * <li> <a href="https://www.ietf.org/rfc/rfc1738.txt ">RFC-1738</a>3.1, host</li>
+ * <li> <a href="https://tools.ietf.org/html/rfc1123">RFC-1123</a> 2.1</li>
+ * </ol>
+ * <p>
*
- * Deliberately allow:
- * - short domain name (often there are rules like minimum of 3 characters)
- * - long domain name (normally limit on whole domain of 255 and for each subdomain/label of 63)
- * - starting by numbers (disallowed by RFC-952 and RFC-1034, but nowadays it's supported by RFC-1123)
- * - use of underscore (not explicitly allowed in RFC but could occur in internal network, we do not speak about path here, just domain)
- * - custom TLD like "intern" that is not standard but could be registered locally in a network
+ * Deliberately allow: <ol>
+ * <li> short domain name (often there are rules like minimum of 3 characters)</li>
+ * <li> long domain name (normally limit on whole domain of 255 and for each subdomain/label of 63)</li>
+ * <li> starting by numbers (disallowed by RFC-952 and RFC-1034, but nowadays it's supported by RFC-1123)</li>
+ * <li> use of underscore (not explicitly allowed in RFC but could occur in internal network, we do not speak about path here, just domain)</li>
+ * <li> custom TLD like "intern" that is not standard but could be registered locally in a network</li>
+ * </ol>
*/
private static String DOMAIN_REGEX = System.getProperty(
UrlHelper.class.getName() + ".DOMAIN_REGEX",
