Mercurial > hg > monetdb-java

diff src/main/java/org/monetdb/jdbc/MonetDatabaseMetaData.java @ 626:06d69b82d409

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Resolve javadoc error and warnings : [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetDriver.java:35: error: tag not supported in the generated HTML version: tt [javadoc] * <tt>jdbc:monetdb://&lt;host&gt;[:&lt;port&gt;]/&lt;database&gt;</tt> [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/io/LineType.java:58: warning: no @param for line [javadoc] public static final LineType classify(String line) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/io/LineType.java:58: warning: no @return [javadoc] public static final LineType classify(String line) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/io/LineType.java:72: warning: no @param for line [javadoc] public static final LineType classify(byte[] line) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/io/LineType.java:72: warning: no @return [javadoc] public static final LineType classify(byte[] line) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:1700: warning: no @return [javadoc] public UploadHandler getUploadHandler() { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:1716: warning: no @return [javadoc] public DownloadHandler getDownloadHandler() { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3511: warning: no @param for errorMessage [javadoc] public void sendError(final String errorMessage) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3511: warning: no @throws for java.io.IOException [javadoc] public void sendError(final String errorMessage) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3525: warning: no @return [javadoc] public InputStream getStream() throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3525: warning: no @throws for java.io.IOException [javadoc] public InputStream getStream() throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3539: warning: no @param for stream [javadoc] public void downloadTo(final OutputStream stream) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3539: warning: no @throws for java.io.IOException [javadoc] public void downloadTo(final OutputStream stream) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3553: warning: no description for @param [javadoc] * @param writer [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3555: warning: no @throws for java.io.IOException [javadoc] public void downloadTo(final Writer writer) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3336: warning: no @throws for java.io.IOException [javadoc] void handleDownload(Download handle, String name, boolean textMode) throws IOException; [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3367: warning: no @throws for java.io.IOException [javadoc] public void sendError(final String errorMessage) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3378: warning: no @param for chunkSize [javadoc] public void setChunkSize(final int chunkSize) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3387: warning: no @return [javadoc] public PrintStream getStream() throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3387: warning: no @throws for java.io.IOException [javadoc] public PrintStream getStream() throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3423: warning: no @param for inputStream [javadoc] public void uploadFrom(final InputStream inputStream) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3423: warning: no @throws for java.io.IOException [javadoc] public void uploadFrom(final InputStream inputStream) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3441: warning: no @throws for java.io.IOException [javadoc] public void uploadFrom(final BufferedReader reader, final long linesToSkip) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3456: warning: no @throws for java.io.IOException [javadoc] public void uploadFrom(final Reader reader) throws IOException { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetConnection.java:3308: warning: no @throws for java.io.IOException [javadoc] void handleUpload(Upload handle, String name, boolean textMode, long linesToSkip) throws IOException; [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/jdbc/MonetDatabaseMetaData.java:114: warning: @return has already been specified [javadoc] * @return negative of nullsAreSortedHigh() [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/net/MapiSocket.java:732: warning: no @param for b [javadoc] public boolean setInsertFakePrompts(boolean b) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/net/MapiSocket.java:732: warning: no @return [javadoc] public boolean setInsertFakePrompts(boolean b) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/net/MapiSocket.java:1184: warning: no @return [javadoc] public UploadStream uploadStream(int chunkSize) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/net/MapiSocket.java:1193: warning: no @return [javadoc] public UploadStream uploadStream() { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/net/MapiSocket.java:1203: warning: no @return [javadoc] public DownloadStream downloadStream(boolean prependCr) { [javadoc] ^ [javadoc] /home/dinther/dev/javadev/src/main/java/org/monetdb/mcl/net/MapiSocket.java:1259: warning: no @param for cancellationCallback [javadoc] public void setCancellationCallback(final Runnable cancellationCallback) { [javadoc] ^ [javadoc] Building index for all the packages and classes... [javadoc] Building index for all classes... [javadoc] Building index for all classes... [javadoc] Generating /home/dinther/dev/javadev/doc/help-doc.html... [javadoc] 1 error [javadoc] 31 warnings
author Martin van Dinther <martin.van.dinther@monetdbsolutions.com>
date Thu, 20 Jan 2022 19:07:45 +0100 (2022-01-20)
parents ffc2fc8e82ec
children dd9b4fb14256
line wrap: on
line diff
--- a/src/main/java/org/monetdb/jdbc/MonetDatabaseMetaData.java
+++ b/src/main/java/org/monetdb/jdbc/MonetDatabaseMetaData.java
@@ -96,7 +96,8 @@ public class MonetDatabaseMetaData
 	 * In an ascending order, if this method returns true, NULL values will appear at the end.
 	 * By contrast, the method nullsAreSortedAtEnd indicates whether NULL values are sorted at the end regardless of sort order.
 	 *
-	 * @return false because MonetDB shows NULL values at the beginning upon ORDER BY .. ASC
+	 * @return false because MonetDB shows NULL values at the beginning upon ORDER BY .. ASC, not at the end
+	 * @see #nullsAreSortedLow()
 	 */
 	@Override
 	public boolean nullsAreSortedHigh() {
@@ -110,8 +111,6 @@ public class MonetDatabaseMetaData
 	 * By contrast, the method nullsAreSortedAtStart indicates whether NULL values are sorted at the beginning regardless of sort order.
 	 *
 	 * @return true because MonetDB shows NULL values at the beginning upon ORDER BY .. ASC
-	 *
-	 * @return negative of nullsAreSortedHigh()
 	 * @see #nullsAreSortedHigh()
 	 */
 	@Override
@@ -362,7 +361,7 @@ public class MonetDatabaseMetaData
 
 	/**
 	 * Internal utility method getConcatenatedStringFromQuery(String query)
-	 * args: query: SQL SELECT query. Only the output of the first column is concatenated.
+	 * @param query the SQL SELECT query. Only the output of the first column is fetched and concatenated.
 	 * @return a String of query result values concatenated into one string, and values separated by comma's
 	 */
 	private String getConcatenatedStringFromQuery(final String query) {