From 5a2e91b34e5eeeed5ca55f5551a2fff29e99165c Mon Sep 17 00:00:00 2001 From: Matt Willer Date: Tue, 23 Jan 2018 23:41:26 -0800 Subject: [PATCH] Fix more documentation issues --- doc/files.md | 2 +- doc/legal_holds.md | 2 +- doc/metadata_template.md | 12 ++++++------ doc/retention_policies.md | 12 ++++++------ doc/tasks.md | 2 +- doc/terms_of_service.md | 6 +++--- doc/users.md | 7 +++---- doc/webhooks.md | 2 +- 8 files changed, 22 insertions(+), 23 deletions(-) diff --git a/doc/files.md b/doc/files.md index 90a6bd982..670200853 100644 --- a/doc/files.md +++ b/doc/files.md @@ -497,7 +497,7 @@ Date expiresAt = new Date(); file.lock(expiresAt); ``` -[lock]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#lock-java.lang.Date- +[lock]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#lock-java.util.Date- Unlock a File ------------- diff --git a/doc/legal_holds.md b/doc/legal_holds.md index 8855e3d97..91abb5192 100644 --- a/doc/legal_holds.md +++ b/doc/legal_holds.md @@ -78,7 +78,7 @@ info.addPendingChange("description", "new description"); policy.updateInfo(info); ``` -[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxLegalHoldPolicy.html#update-com.box.sdk.BoxLegalHoldPolicy.Info- +[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxLegalHoldPolicy.html#updateInfo-com.box.sdk.BoxLegalHoldPolicy.Info- Delete Legal Hold Policy ------------------------ diff --git a/doc/metadata_template.md b/doc/metadata_template.md index 6b33073b8..ac3d487bb 100644 --- a/doc/metadata_template.md +++ b/doc/metadata_template.md @@ -33,7 +33,7 @@ Metadata metadata = new Metadata(jsonObject); boxFile.createMetadata("CustomField", metadata); ``` -[create-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#createMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.Boolean-java.lang.List- +[create-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#createMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.String-boolean-java.util.List- Update Metadata Template ------------------------ @@ -68,9 +68,9 @@ Also [`getMetadataTemplate(BoxAPIConnection, String)`][get-metadata-template-2] MetadataTemplate template = MetadataTemplate.getMetadataTemplate(api, "templateName"); ``` -[get-metadata-template-1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection- -[get-metadata-template-2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-java.lang.String- -[get-metadata-template-3]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.String...- +[get-metadata-template-1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getMetadataTemplate-com.box.sdk.BoxAPIConnection- +[get-metadata-template-2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String- +[get-metadata-template-3]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String-java.lang.String...- Get Enterprise Metadata Templates @@ -94,11 +94,11 @@ for (MetadataTemplate templateInfo : templates) { Delete a Metadata Template -------------------------- -The ['deleteMetadataTemplate(BoxAPIConnection, String scope, String template)'][delete-metadata-template] method will remove a metadata template schema +The [`deleteMetadataTemplate(BoxAPIConnection, String scope, String template)`][delete-metadata-template] method will remove a metadata template schema from an enterprise. ```java MetadataTemplate.deleteMetadataTemplate(api, "enterprise", "templateName"); ``` -[delete-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String- \ No newline at end of file +[delete-metadata-template]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#deleteMetadataTemplate-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String- \ No newline at end of file diff --git a/doc/retention_policies.md b/doc/retention_policies.md index 28e2c29b0..d415c39a3 100644 --- a/doc/retention_policies.md +++ b/doc/retention_policies.md @@ -78,7 +78,7 @@ for (BoxRetentionPolicy.Info policyInfo : policies) { Get Retention Policy Assignments -------------- -Calling [`getAllAssignments(String...)`][get-all-assignments] will return an iterable that will page through all of the assignments of the retention policy. It is possible to specify maximum number of items per single response and fields to retrieve by calling [`getFolderAssignments(int, String...)`][get-all-assignments-with-params]. +Calling [`getAllAssignments(String...)`][get-all-assignments] will return an iterable that will page through all of the assignments of the retention policy. It is possible to specify maximum number of items per single response and fields to retrieve by calling [`getAllAssignments(int, String...)`][get-all-assignments-with-params]. If it is necessary to retrieve only assignments of certain type, you can call [`getFolderAssignments(int, String...)`][get-folder-assignments] or [`getEnterpriseAssignments(int, String...)`][get-enterprise-assignments]. ```java @@ -100,7 +100,7 @@ for (BoxRetentionPolicyAssignments.Info assignmentInfo : enterpriseAssignments) [get-all-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getAllAssignments-java.lang.String...- [get-all-assignments-with-params]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getAllAssignments-int-java.lang.String...- [get-folder-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getFolderAssignments-int-java.lang.String...- -[get-enterprise-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getEnterpiseAssignments-int-java.lang.String...- +[get-enterprise-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getEnterpriseAssignments-int-java.lang.String...- Create Retention Policy Assignment -------------- @@ -143,7 +143,7 @@ BoxFileVersionRetention.Info policyInfo = policy.getInfo(); Get File Version Retentions -------------- -To get an iterable with all file version retentions for current retention policy, call the static [`getAll(BoxAPIConnection, String...)`][get-all-file-version-retentions]. It is possible to add filters to query using [`QueryFilter`][query-filter] object as a parameter: [`getAll(BoxAPIConnection, QueryFilter, String...)`][get-all-file-version-retentions-with-filter]. +To get an iterable with all file version retentions for current retention policy, call the static [`getAll(BoxAPIConnection, String...)`][get-all-file-version-retentions]. It is possible to add filters to query using [`QueryFilter`][query-filter] object as a parameter: [`getRetentions(BoxAPIConnection, QueryFilter, String...)`][get-all-file-version-retentions-with-filter]. ```java BoxFileVersionRetention.QueryFilter filter = new BoxFileVersionRetention.QueryFilter() @@ -160,6 +160,6 @@ for (BoxFileVersionRetention.Info retentionInfo : retentions) { } ``` -[get-all-file-version-retentions]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getInfo-com.box.sdk.BoxAPIConnection-java.lang.String...- -[query-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#QueryFilter -[get-all-file-version-retentions-with-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getInfo-com.box.sdk.BoxAPIConnection-com.box.sdk.BoxFileVersionRetention.QueryFilter-java.lang.String...- +[get-all-file-version-retentions]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getAll-com.box.sdk.BoxAPIConnection-java.lang.String...- +[query-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.QueryFilter.html +[get-all-file-version-retentions-with-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#getRetentions-com.box.sdk.BoxAPIConnection-com.box.sdk.BoxFileVersionRetention.QueryFilter-java.lang.String...- diff --git a/doc/tasks.md b/doc/tasks.md index 94e5ef0ff..91ba431fd 100644 --- a/doc/tasks.md +++ b/doc/tasks.md @@ -128,4 +128,4 @@ BoxTaskAssignment.Info info = taskAssignment.getInfo(); taskAssignment.updateInfo(info); ``` -[update-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxTaskAssignment.html#updateInfo-com.box.sdk.BoxTask.Info- \ No newline at end of file +[update-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxTaskAssignment.html#updateInfo-com.box.sdk.BoxTaskAssignment.Info- \ No newline at end of file diff --git a/doc/terms_of_service.md b/doc/terms_of_service.md index ae01eabd2..ccf4e73a9 100644 --- a/doc/terms_of_service.md +++ b/doc/terms_of_service.md @@ -93,7 +93,7 @@ If they have then you will need to make the update call. Accept or decline a Terms of Service for existing user ------------------------------------------------------ -For an existing user you can accept or decline a terms of service by calling [`updateInfo(BoxTermsOfService.Info)``][update-user-status] +For an existing user you can accept or decline a terms of service by calling [`updateInfo(BoxTermsOfService.Info)`][update-user-status] ```java BoxTermsOfServiceUserStatus tosUserStatus = new BoxTermsOfServiceUserStatus(api, "tos-user-status-id"); @@ -107,7 +107,7 @@ tosUserStatus.updateInfo(tosUSerStatusInfo); Get User Status on a Terms of service ------------------------------------- -You can retrieve the terms of service status for a user by calling[`getInfo(BoxApiConnection, String, String)``][get-user-status1] +You can retrieve the terms of service status for a user by calling[`getInfo(BoxApiConnection, String, String)`][get-user-status1] ```java List tosUserStatusInfo = BoxTermsOfServiceUserStatus.getInfo(api, "tos-id", "user-id"); @@ -116,7 +116,7 @@ for(BoxTermsOfServiceUserStatus.Info info : toUserStatusInfo){ } ``` -Alternatively you can get the user status by the ID of the terms of service by calling[`getInfo(BoxApiConnection, String)``][get-user-status2] +Alternatively you can get the user status by the ID of the terms of service by calling[`getInfo(BoxApiConnection, String)`][get-user-status2] ```java List tosUserStatusInfo = BoxTermsOfServiceUserStatus.getInfo(api, "tos-id"); diff --git a/doc/users.md b/doc/users.md index 8068025a3..cbcfc22a5 100644 --- a/doc/users.md +++ b/doc/users.md @@ -19,9 +19,8 @@ Users represent an individual's account on Box. Get the Current User's Information ---------------------------------- -To get the current user, call the static [`getCurrentUser(BoxAPIConnection)`] -[get-current-user] method. Then use [`getInfo()`][get-info] to get information -about the user. +To get the current user, call the static [`getCurrentUser(BoxAPIConnection)`][get-current-user] method. +Then use [`getInfo(String...)`][get-info] to get information about the user. ```java BoxUser user = BoxUser.getCurrentUser(api); @@ -29,7 +28,7 @@ BoxUser.Info info = user.getInfo(); ``` [get-current-user]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getCurrentUser-com.box.sdk.BoxAPIConnection- -[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getInfo-- +[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getInfo-java.lang.String...- Create An Enterprise User ------------------------- diff --git a/doc/webhooks.md b/doc/webhooks.md index 4e771f1e2..31e7fb4cc 100644 --- a/doc/webhooks.md +++ b/doc/webhooks.md @@ -72,4 +72,4 @@ info.addPendingChange("address", url); webhook.update(info); ``` -[update]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxWebHook.html#update-com.box.sdk.BoxWebHook.Info- \ No newline at end of file +[update]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxWebHook.html#updateInfo-com.box.sdk.BoxWebHook.Info-