Permalink
Browse files

chore: add missing javadoc tags to avoid warnings (#1164)

Some missing javadoc tags were generating warnings when building
the documentation. This commit provides those missing tags.
  • Loading branch information...
lordnelson authored and vlsi committed Jun 30, 2018
1 parent 7018920 commit e9ced455fd118731eb7dea38a63e0b400df32a1b
@@ -3,10 +3,6 @@
* See the LICENSE file in the project root for more information.
*/
/**
* Bulk data copy for PostgreSQL
*/
package org.postgresql.copy;
import org.postgresql.core.BaseConnection;
@@ -3027,7 +3027,7 @@ private double readDoubleValue(byte[] bytes, int oid, String targetType) throws
* @param bytes The bytes of the numeric field.
* @param oid The oid of the field.
* @param minVal the minimum value allowed.
* @param minVal the maximum value allowed.
* @param maxVal the maximum value allowed.
* @param targetType The target type. Used for error reporting.
* @return The value as long.
* @throws PSQLException If the field type is not supported numeric type or if the value is out of
@@ -820,6 +820,8 @@ public synchronized String toString(OffsetDateTime offsetDateTime) {
/**
* Formats {@link LocalDateTime} to be sent to the backend, thus it adds time zone.
* Do not use this method in {@link java.sql.ResultSet#getString(int)}
* @param localDateTime The local date to format as a String
* @return The formatted local date
*/
public synchronized String toString(LocalDateTime localDateTime) {
if (localDateTime.isAfter(MAX_LOCAL_DATETIME)) {
@@ -39,6 +39,7 @@
/**
* @param slotName not null replication slot name exists in database that should be drop
* @throws SQLException if the replication slot cannot be dropped.
*/
void dropReplicationSlot(String slotName) throws SQLException;
}
@@ -20,6 +20,7 @@
* rows which could cause a recovery conflict even when the standby is disconnected.
*
* @param slotName not null replication slot already exists on server.
* @return this instance as a fluent interface
*/
T withSlotName(String slotName);
@@ -36,7 +36,8 @@
* terminator (out)
* @param spn SPN buffer (in/out)
* @return Error code ERROR_SUCCESS, ERROR_BUFFER_OVERFLOW or ERROR_INVALID_PARAMETER
* @see "http://msdn.microsoft.com/en-us/library/ms676007(v=vs.85).aspx"
* @see <a href="https://msdn.microsoft.com/en-us/library/ms676007(v=vs.85).aspx">
* https://msdn.microsoft.com/en-us/library/ms676007(v=vs.85).aspx</a>
*/
int DsMakeSpnW(WString serviceClass, /* in */
WString serviceName, /* in */
@@ -24,8 +24,8 @@
* @param referrer See MSDN
* @return SPN generated
* @throws LastErrorException If buffer too small or parameter incorrect
* @see <a href="http://msdn.microsoft.com/en-us/library/ms676007(v=vs.85).aspx">http://msdn.
* microsoft.com/en-us/library/ms676007</a>
* @see <a href="https://msdn.microsoft.com/en-us/library/ms676007(v=vs.85).aspx">
* https://msdn.microsoft.com/en-us/library/ms676007(v=vs.85).aspx</a>
*/
public String DsMakeSpn(String serviceClass, String serviceName, String instanceName,
short instancePort, String referrer) throws LastErrorException {
@@ -126,7 +126,7 @@
(byte) '6', (byte) '7', (byte) '8', (byte) '9', (byte) '+', (byte) '/'
};
/** Determine which ALPHABET to use. */
/* Determine which ALPHABET to use. */
static {
byte[] __bytes;
try {
@@ -5,15 +5,14 @@
package org.postgresql.util;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
/**
* MD5-based utility function to obfuscate passwords before network transmission.
*
* @author Jeremy Wohl
*/
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
public class MD5Digest {
private MD5Digest() {
}
@@ -1,4 +1,4 @@
/**
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -17,7 +17,6 @@
* under the License.
*/
package org.postgresql.util;
import java.io.Writer;
@@ -152,9 +152,6 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl
}
}
/**** XAResource interface ****/
/**
* Preconditions: 1. flags must be one of TMNOFLAGS, TMRESUME or TMJOIN 2. xid != null 3.
* connection must not be associated with a transaction 4. the TM hasn't seen the xid before

0 comments on commit e9ced45

Please sign in to comment.