Mercurial > hg > monetdb-java
diff src/main/java/org/monetdb/mcl/net/MapiSocket.java @ 626:06d69b82d409
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://<host>[:<port>]/<database></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 | 65641a7cea31 |
| children | c6fe5dfecafc |
line wrap: on
line diff
--- a/src/main/java/org/monetdb/mcl/net/MapiSocket.java +++ b/src/main/java/org/monetdb/mcl/net/MapiSocket.java @@ -728,6 +728,9 @@ public class MapiSocket { /* cannot (yet /** * For internal use + * + * @param b to enable/disable insert 'fake' newline and prompt + * @return previous setting */ public boolean setInsertFakePrompts(boolean b) { return fromMonet.setInsertFakePrompts(b); @@ -1179,7 +1182,9 @@ public class MapiSocket { /* cannot (yet * Return an UploadStream for use with for example COPY FROM filename ON CLIENT. * * Building block for {@link org.monetdb.jdbc.MonetConnection.UploadHandler}. + * * @param chunkSize chunk size for the upload stream + * @return UploadStream new upload stream with the given chunk size */ public UploadStream uploadStream(int chunkSize) { return new UploadStream(chunkSize); @@ -1189,6 +1194,8 @@ public class MapiSocket { /* cannot (yet * Return an UploadStream for use with for example COPY FROM filename ON CLIENT. * * Building block for {@link org.monetdb.jdbc.MonetConnection.UploadHandler}. + * + * @return UploadStream new upload stream */ public UploadStream uploadStream() { return new UploadStream(); @@ -1198,7 +1205,9 @@ public class MapiSocket { /* cannot (yet * Return a DownloadStream for use with for example COPY INTO filename ON CLIENT * * Building block for {@link org.monetdb.jdbc.MonetConnection.DownloadHandler}. + * * @param prependCr convert \n to \r\n + * @return DownloadStream new download stream */ public DownloadStream downloadStream(boolean prependCr) { return new DownloadStream(fromMonet.getRaw(), toMonet, prependCr); @@ -1255,6 +1264,8 @@ public class MapiSocket { /* cannot (yet } /** Set a callback to be invoked if the server cancels the upload + * + * @param cancellationCallback callback to call */ public void setCancellationCallback(final Runnable cancellationCallback) { this.cancellationCallback = cancellationCallback;