Skip to content
Permalink
Browse files
doc: fix HTML5 errors in javadoc
  • Loading branch information
vlsi committed Mar 6, 2020
1 parent 2509b66 commit 161ea24965b3d11067f96b9765cda10f8b59e08b
Showing 8 changed files with 31 additions and 30 deletions.
@@ -123,15 +123,15 @@ ResultSet execSQLQuery(String s, int resultSetType, int resultSetConcurrency)
*
* @param str a string value
* @return the escaped representation of the string
* @throws SQLException if the string contains a <tt>\0</tt> character
* @throws SQLException if the string contains a {@code \0} character
*/
String escapeString(String str) throws SQLException;

/**
* Returns whether the server treats string-literals according to the SQL standard or if it uses
* traditional PostgreSQL escaping rules. Versions up to 8.1 always treated backslashes as escape
* characters in string-literals. Since 8.2, this depends on the value of the
* <tt>standard_conforming_strings</tt> server variable.
* {@code standard_conforming_strings} server variable.
*
* @return true if the server treats string literals according to the SQL standard
* @see QueryExecutor#getStandardConformingStrings()
@@ -387,8 +387,8 @@ private static int[] toIntArray(List<Integer> list) {
/**
* <p>Find the end of the single-quoted string starting at the given offset.</p>
*
* <p>Note: for <tt>'single '' quote in string'</tt>, this method currently returns the offset of
* first <tt>'</tt> character after the initial one. The caller must call the method a second time
* <p>Note: for {@code 'single '' quote in string'}, this method currently returns the offset of
* first {@code '} character after the initial one. The caller must call the method a second time
* for the second part of the quoted string.</p>
*
* @param query query
@@ -437,8 +437,8 @@ && charTerminatesIdentifier(query[offset - 2])) {
/**
* <p>Find the end of the double-quoted string starting at the given offset.</p>
*
* <p>Note: for <tt>&quot;double &quot;&quot; quote in string&quot;</tt>, this method currently
* returns the offset of first <tt>&quot;</tt> character after the initial one. The caller must
* <p>Note: for {@code "double "" quote in string"}, this method currently
* returns the offset of first {@code &quot;} character after the initial one. The caller must
* call the method a second time for the second part of the quoted string.</p>
*
* @param query query
@@ -453,7 +453,7 @@ public static int parseDoubleQuotes(final char[] query, int offset) {
}

/**
* Test if the dollar character (<tt>$</tt>) at the given offset starts a dollar-quoted string and
* Test if the dollar character ({@code $}) at the given offset starts a dollar-quoted string and
* return the offset of the ending dollar character.
*
* @param query query
@@ -494,12 +494,12 @@ && subArraysEqual(query, tagIdx, offset, tagLen)) {
}

/**
* Test if the <tt>-</tt> character at <tt>offset</tt> starts a <tt>--</tt> style line comment,
* and return the position of the first <tt>\r</tt> or <tt>\n</tt> character.
* Test if the {@code -} character at {@code offset} starts a {@code --} style line comment,
* and return the position of the first {@code \r} or {@code \n} character.
*
* @param query query
* @param offset start offset
* @return position of the first <tt>\r</tt> or <tt>\n</tt> character
* @return position of the first {@code \r} or {@code \n} character
*/
public static int parseLineComment(final char[] query, int offset) {
if (offset + 1 < query.length && query[offset + 1] == '-') {
@@ -514,12 +514,12 @@ public static int parseLineComment(final char[] query, int offset) {
}

/**
* Test if the <tt>/</tt> character at <tt>offset</tt> starts a block comment, and return the
* position of the last <tt>/</tt> character.
* Test if the {@code /} character at {@code offset} starts a block comment, and return the
* position of the last {@code /} character.
*
* @param query query
* @param offset start offset
* @return position of the last <tt>/</tt> character
* @return position of the last {@code /} character
*/
public static int parseBlockComment(final char[] query, int offset) {
if (offset + 1 < query.length && query[offset + 1] == '*') {
@@ -409,7 +409,7 @@ Object createQueryKey(String sql, boolean escapeProcessing, boolean isParameteri
* Returns whether the server treats string-literals according to the SQL standard or if it uses
* traditional PostgreSQL escaping rules. Versions up to 8.1 always treated backslashes as escape
* characters in string-literals. Since 8.2, this depends on the value of the
* <tt>standard_conforming_strings</tt> server variable.
* {@code standard_conforming_strings} server variable.
*
* @return true if the server treats string literals according to the SQL standard
*/
@@ -54,16 +54,16 @@ public static byte[] encodeUTF8(String str) {
}

/**
* Escape the given literal <tt>value</tt> and append it to the string builder <tt>sbuf</tt>. If
* <tt>sbuf</tt> is <tt>null</tt>, a new StringBuilder will be returned. The argument
* <tt>standardConformingStrings</tt> defines whether the backend expects standard-conforming
* Escape the given literal {@code value} and append it to the string builder {@code sbuf}. If
* {@code sbuf} is {@code null}, a new StringBuilder will be returned. The argument
* {@code standardConformingStrings} defines whether the backend expects standard-conforming
* string literals or allows backslash escape sequences.
*
* @param sbuf the string builder to append to; or <tt>null</tt>
* @param sbuf the string builder to append to; or {@code null}
* @param value the string value
* @param standardConformingStrings if standard conforming strings should be used
* @return the sbuf argument; or a new string builder for sbuf == null
* @throws SQLException if the string contains a <tt>\0</tt> character
* @throws SQLException if the string contains a {@code \0} character
*/
public static StringBuilder escapeLiteral(StringBuilder sbuf, String value,
boolean standardConformingStrings) throws SQLException {
@@ -123,15 +123,15 @@ private static void doAppendEscapedLiteral(Appendable sbuf, String value,
}

/**
* Escape the given identifier <tt>value</tt> and append it to the string builder <tt>sbuf</tt>.
* If <tt>sbuf</tt> is <tt>null</tt>, a new StringBuilder will be returned. This method is
* Escape the given identifier {@code value} and append it to the string builder {@code sbuf}.
* If {@code sbuf} is {@code null}, a new StringBuilder will be returned. This method is
* different from appendEscapedLiteral in that it includes the quoting required for the identifier
* while {@link #escapeLiteral(StringBuilder, String, boolean)} does not.
*
* @param sbuf the string builder to append to; or <tt>null</tt>
* @param sbuf the string builder to append to; or {@code null}
* @param value the string value
* @return the sbuf argument; or a new string builder for sbuf == null
* @throws SQLException if the string contains a <tt>\0</tt> character
* @throws SQLException if the string contains a {@code \0} character
*/
public static StringBuilder escapeIdentifier(StringBuilder sbuf, String value)
throws SQLException {
@@ -71,7 +71,7 @@ public PooledConnection getPooledConnection(String user, String password) throws

/**
* Gets whether connections supplied by this pool will have autoCommit turned on by default. The
* default value is <tt>true</tt>, so that autoCommit will be turned on by default.
* default value is {@code true}, so that autoCommit will be turned on by default.
*
* @return true if connections supplied by this pool will have autoCommit
*/
@@ -81,7 +81,7 @@ public boolean isDefaultAutoCommit() {

/**
* Sets whether connections supplied by this pool will have autoCommit turned on by default. The
* default value is <tt>true</tt>, so that autoCommit will be turned on by default.
* default value is {@code true}, so that autoCommit will be turned on by default.
*
* @param defaultAutoCommit whether connections supplied by this pool will have autoCommit
*/
@@ -148,7 +148,7 @@ public String[] getServerNames() {

/**
* Sets the name of the host the PostgreSQL database is running on. If this is changed, it will
* only affect future calls to getConnection. The default value is <tt>localhost</tt>.
* only affect future calls to getConnection. The default value is {@code localhost}.
*
* @param serverName name of the host the PostgreSQL database is running on
* @deprecated use {@link #setServerNames(String[])}
@@ -160,7 +160,7 @@ public void setServerName(String serverName) {

/**
* Sets the name of the host(s) the PostgreSQL database is running on. If this is changed, it will
* only affect future calls to getConnection. The default value is <tt>localhost</tt>.
* only affect future calls to getConnection. The default value is {@code localhost}.
*
* @param serverNames name of the host(s) the PostgreSQL database is running on
*/
@@ -37,7 +37,8 @@
* <p>Where the certificate is loaded from is based upon the prefix of the <code>sslfactoryarg</code> property.
* The following table lists the valid set of prefixes.</p>
*
* <table border="1" summary="Valid prefixes for sslfactoryarg">
* <table border="1">
* <caption>Valid prefixes for sslfactoryarg</caption>
* <tr>
* <th>Prefix</th>
* <th>Example</th>
@@ -27,10 +27,10 @@
* <li>v2.0 - I got rid of methods that used booleans to set options. Now everything is more
* consolidated and cleaner. The code now detects when data that's being decoded is gzip-compressed
* and will decompress it automatically. Generally things are cleaner. You'll probably have to
* change some method calls that you were making to support the new options format (<tt>int</tt>s
* change some method calls that you were making to support the new options format ({@code int}s
* that you "OR" together).</li>
* <li>v1.5.1 - Fixed bug when decompressing and decoding to a byte[] using
* <tt>decode( String s, boolean gzipCompressed )</tt>. Added the ability to "suspend" encoding in
* {@code decode( String s, boolean gzipCompressed )}. Added the ability to "suspend" encoding in
* the Output Stream so you can turn on and off the encoding if you need to embed base64 data in an
* otherwise "normal" stream (like an XML file).</li>
* <li>v1.5 - Output stream pases on flush() command but doesn't do anything itself. This helps when

0 comments on commit 161ea24

Please sign in to comment.