Improve maven #6

linl33 · 2017-11-21T00:32:28Z

Add source + javadoc jars for sync-client + aggregate-rest-interface
Organize pom.xml
Emit javadoc + source jars
Update Maven build plugins version

Depends on odk-x/sync-client#6 for sync-client source + javadoc jars

…ment

…velopment

clarlars · 2017-11-22T01:03:18Z

The change looks good, but please fix the following javadoc issues.

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 17.982 s
[INFO] Finished at: 2017-11-21T16:41:04-08:00
[INFO] Final Memory: 55M/393M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project suitcase: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:201: warning: no description for @param
[ERROR] * @param config
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:202: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:249: warning: no description for @param
[ERROR] * @param rows
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:251: warning: no description for @throws
[ERROR] * @throws JSONException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:252: warning: no description for @throws
[ERROR] * @throws IOException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:285: warning: no description for @param
[ERROR] * @param rowIndex
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:286: warning: no description for @param
[ERROR] * @param config
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:287: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:288: warning: no description for @throws
[ERROR] * @throws JSONException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:289: warning: no description for @throws
[ERROR] * @throws IOException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:290: error: exception not thrown: java.lang.Exception
[ERROR] * @throws Exception
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:290: warning: no description for @throws
[ERROR] * @throws Exception
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:190: warning: no description for @param
[ERROR] * @param attMngr
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:191: warning: no description for @param
[ERROR] * @param cloudEndpointInfo
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:193: warning: no @param for tableId
[ERROR] public ODKCsv(AttachmentManager attMngr, CloudEndpointInfo cloudEndpointInfo, String tableId)
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:193: warning: no @throws for org.apache.wink.json4j.JSONException
[ERROR] public ODKCsv(AttachmentManager attMngr, CloudEndpointInfo cloudEndpointInfo, String tableId)
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:150: warning: no description for @param
[ERROR] * @param rows
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:151: warning: no description for @param
[ERROR] * @param attMngr
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:152: warning: no description for @param
[ERROR] * @param cloudEndpointInfo
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:153: warning: no description for @throws
[ERROR] * @throws JSONException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:155: warning: no @param for tableId
[ERROR] public ODKCsv(JSONArray rows, AttachmentManager attMngr, CloudEndpointInfo cloudEndpointInfo, String tableId)
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:43: warning: no description for @param
[ERROR] * @param rowId
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:75: warning: no description for @param
[ERROR] * @param rowId
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:76: warning: no description for @param
[ERROR] * @param filename
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:78: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:79: warning: no description for @throws
[ERROR] * @throws IOException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:106: warning: no description for @param
[ERROR] * @param rowId
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:108: warning: no description for @throws
[ERROR] * @throws IOException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:142: warning: no description for @param
[ERROR] * @param rowId
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:143: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:144: warning: no description for @throws
[ERROR] * @throws IOException
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/net/AttachmentManager.java:163: warning: no description for @param
[ERROR] * @param path
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/ui/DialogUtils.java:20: warning: no @param for isGUI
[ERROR] public static void showError(String errMsg, boolean isGUI) {
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/ui/LayoutDefault.java:9: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FieldsValidatorUtils.java:15: warning: no description for @param
[ERROR] * @param cloudEndpointUrl
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FieldsValidatorUtils.java:16: warning: no description for @param
[ERROR] * @param appId
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FieldsValidatorUtils.java:17: warning: no description for @param
[ERROR] * @param username
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FieldsValidatorUtils.java:18: warning: no description for @param
[ERROR] * @param password
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FieldsValidatorUtils.java:19: warning: no description for @param
[ERROR] * @param isAnonymous
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:31: warning: no description for @param
[ERROR] * @param cloudEndpointInfo
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:32: warning: no description for @param
[ERROR] * @param savePath
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:33: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:35: warning: no @param for tableId
[ERROR] public static boolean isDownloaded(CloudEndpointInfo cloudEndpointInfo, String tableId, String savePath) {
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:42: warning: no description for @param
[ERROR] * @param cloudEndpointInfo
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:43: warning: no description for @param
[ERROR] * @param savePath
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:44: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:46: warning: no @param for tableId
[ERROR] public static boolean isDownloaded(CloudEndpointInfo cloudEndpointInfo, String tableId, CsvConfig config,
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:46: warning: no @param for config
[ERROR] public static boolean isDownloaded(CloudEndpointInfo cloudEndpointInfo, String tableId, CsvConfig config,
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:54: warning: no description for @param
[ERROR] * @param cloudEndpointInfo
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:55: warning: no description for @param
[ERROR] * @param config
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:56: warning: no description for @param
[ERROR] * @param savePath
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:59: warning: no @param for tableId
[ERROR] public static Path getCSVPath(CloudEndpointInfo cloudEndpointInfo, String tableId, CsvConfig config,
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:102: warning: no description for @param
[ERROR] * @param cloudEndpointInfo
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:103: warning: no description for @param
[ERROR] * @param tableId
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:104: warning: no description for @param
[ERROR] * @param savePath
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:113: warning: no description for @param
[ERROR] * @param cloudEndpointInfo
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:114: warning: no description for @param
[ERROR] * @param savePath
[ERROR] ^
[ERROR] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:117: warning: no @param for tableId
[ERROR] public static Path getInstancesPath(CloudEndpointInfo cloudEndpointInfo, String tableId, String savePath) {
[ERROR] ^
[ERROR]
[ERROR] Command line was: /Library/Java/JavaVirtualMachines/jdk1.8.0_151.jdk/Contents/HOME/bin/javadoc @options @packages
[ERROR]
[ERROR] Refer to the generated Javadoc files in '/Users/clarice/odk-desktop/suitcase-workspace/suitcase/target/apidocs' dir.
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

clarlars · 2017-11-27T20:32:10Z

Thanks for fixing the javadoc issues. There are only 3 more warnings. Please address these. Thanks!

[WARNING] Javadoc Warnings
[WARNING] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:194: warning: no @throws for org.apache.wink.json4j.JSONException
[WARNING] public ODKCsv(AttachmentManager attMngr, CloudEndpointInfo cloudEndpointInfo, String tableId)
[WARNING] ^
[WARNING] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/model/ODKCsv.java:155: warning: no @param for tableId
[WARNING] public ODKCsv(JSONArray rows, AttachmentManager attMngr, CloudEndpointInfo cloudEndpointInfo, String tableId)
[WARNING] ^
[WARNING] /Users/clarice/odk-desktop/suitcase-workspace/suitcase/src/main/java/org/opendatakit/suitcase/utils/FileUtils.java:35: warning: no @param for tableId
[WARNING] public static boolean isDownloaded(CloudEndpointInfo cloudEndpointInfo, String tableId, String savePath) {
[WARNING] ^

linl33 · 2017-11-28T20:01:42Z

Fixed those warnings.

clarlars and others added 8 commits October 23, 2017 19:13

Fix upload file CLI command

75c3d84

add columns

fe363e5

Fix suitcase upload CLI option

bb51372

update METADATA_JSON_NAME

83692fa

Merge remote-tracking branch 'linl33/development' into linl33-develop…

b561aec

…ment

Reduce warnings by removing unused imports and cleaning up the code

bced44e

Merge branch 'development' of github.com:opendatakit/suitcase into de…

b4128b9

…velopment

improve dependency management

4628402

getodk-bot added the needs review label Nov 21, 2017

fix doclint warning/error

d9f3b4c

fix 3 more warnings

aa5cca8

clarlars merged commit 88dedea into odk-x:development Nov 28, 2017

getodk-bot removed the needs review label Nov 28, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve maven #6

Improve maven #6

linl33 commented Nov 21, 2017

clarlars commented Nov 22, 2017

clarlars commented Nov 27, 2017

linl33 commented Nov 28, 2017

Improve maven #6

Improve maven #6

Conversation

linl33 commented Nov 21, 2017

clarlars commented Nov 22, 2017

clarlars commented Nov 27, 2017

linl33 commented Nov 28, 2017