Skip to content

Commit

Permalink
[SQLLINE-132] Fix 9 javadoc warnings (Arina Ielchiieva)
Browse files Browse the repository at this point in the history
  • Loading branch information
arina-ielchiieva authored and julianhyde committed Sep 9, 2018
1 parent 8e89ad9 commit 2633cd9
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 6 deletions.
2 changes: 2 additions & 0 deletions src/main/java/sqlline/Application.java
Expand Up @@ -164,6 +164,8 @@ public Application() {
* <p>Override this method to return a custom information message.
*
* @return custom information message
* @throws Exception in case of errors during
* obtaining application info message
*
* @see #DEFAULT_APP_INFO_MESSAGE
*/
Expand Down
21 changes: 17 additions & 4 deletions src/main/java/sqlline/SqlLine.java
Expand Up @@ -218,10 +218,13 @@ public SqlLine() {
* @param args args[] passed in directly from {@link #main(String[])}
* @param inputStream Stream to read sql commands from (stdin or a file) or
* null for an interactive shell
* @param saveHistory whether or not the commands issued will be saved to
* sqlline's history file
* @param saveHistory Whether to save the commands issued to SQLLine's history
* file
*
* @return Whether successful
* @throws IOException on error
*
* @throws IOException if SQLLine cannot obtain
* history file or start console reader
*/
public static Status start(String[] args,
InputStream inputStream,
Expand Down Expand Up @@ -432,14 +435,24 @@ Status initArgs(String[] args, DispatchCallback callback) {
}

/**
* Runs SqlLine, accepting input from the given input stream,
* Runs SQLLine, accepting input from the given input stream,
* dispatching it to the appropriate
* {@link CommandHandler} until the global variable <code>exit</code> is
* true.
*
* <p>Before you invoke this method, you can redirect output by
* calling {@link #setOutputStream(PrintStream)}
* and/or {@link #setErrorStream(PrintStream)}.
*
* @param args Command-line arguments
* @param inputStream Input stream
* @param saveHistory Whether to save the commands issued to SQLLine's history
* file
*
* @return exit status
*
* @throws IOException if SQLLine cannot obtain
* history file or start console reader
*/
public Status begin(String[] args, InputStream inputStream,
boolean saveHistory) throws IOException {
Expand Down
14 changes: 12 additions & 2 deletions src/main/java/sqlline/SqlLineOpts.java
Expand Up @@ -90,6 +90,8 @@ public List<String> possibleSettingValues() {
/**
* The save directory if HOME/.sqlline/ on UNIX, and HOME/sqlline/ on
* Windows.
*
* @return save directory
*/
public File saveDir() {
String dir = System.getProperty("sqlline.rcfile");
Expand Down Expand Up @@ -476,13 +478,21 @@ public boolean getSilent() {
return this.silent;
}

/** @deprecated Use {@link #setAutoSave(boolean)} */
/**
* @deprecated Use {@link #setAutoSave(boolean)}
*
* @param autoSave auto save flag
*/
@Deprecated
public void setAutosave(boolean autoSave) {
setAutoSave(autoSave);
}

/** @deprecated Use {@link #getAutoSave()} */
/**
* @deprecated Use {@link #getAutoSave()}
*
* @return true if auto save is on, false otherwise
*/
@Deprecated
public boolean getAutosave() {
return getAutoSave();
Expand Down

0 comments on commit 2633cd9

Please sign in to comment.