Skip to content

Commit 8c83e1d

Browse files
author
Matt Willer
authored
Fix more documentation issues (#529)
1 parent 7f6c5db commit 8c83e1d

File tree

8 files changed

+22
-23
lines changed

8 files changed

+22
-23
lines changed

doc/files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ Date expiresAt = new Date();
497497
file.lock(expiresAt);
498498
```
499499

500-
[lock]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#lock-java.lang.Date-
500+
[lock]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#lock-java.util.Date-
501501

502502
Unlock a File
503503
-------------

doc/legal_holds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ info.addPendingChange("description", "new description");
7878
policy.updateInfo(info);
7979
```
8080

81-
[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxLegalHoldPolicy.html#update-com.box.sdk.BoxLegalHoldPolicy.Info-
81+
[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxLegalHoldPolicy.html#updateInfo-com.box.sdk.BoxLegalHoldPolicy.Info-
8282

8383
Delete Legal Hold Policy
8484
------------------------

doc/metadata_template.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Metadata metadata = new Metadata(jsonObject);
3333
boxFile.createMetadata("CustomField", metadata);
3434
```
3535

36-
[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-
36+
[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-
3737

3838
Update Metadata Template
3939
------------------------
@@ -68,9 +68,9 @@ Also [`getMetadataTemplate(BoxAPIConnection, String)`][get-metadata-template-2]
6868
MetadataTemplate template = MetadataTemplate.getMetadataTemplate(api, "templateName");
6969
```
7070

71-
[get-metadata-template-1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getEnterpriseMetadataTemplates-com.box.sdk.BoxAPIConnection-
72-
[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-
73-
[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...-
71+
[get-metadata-template-1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/MetadataTemplate.html#getMetadataTemplate-com.box.sdk.BoxAPIConnection-
72+
[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-
73+
[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...-
7474

7575

7676
Get Enterprise Metadata Templates
@@ -94,11 +94,11 @@ for (MetadataTemplate templateInfo : templates) {
9494
Delete a Metadata Template
9595
--------------------------
9696

97-
The ['deleteMetadataTemplate(BoxAPIConnection, String scope, String template)'][delete-metadata-template] method will remove a metadata template schema
97+
The [`deleteMetadataTemplate(BoxAPIConnection, String scope, String template)`][delete-metadata-template] method will remove a metadata template schema
9898
from an enterprise.
9999

100100
```java
101101
MetadataTemplate.deleteMetadataTemplate(api, "enterprise", "templateName");
102102
```
103103

104-
[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-
104+
[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-

doc/retention_policies.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ for (BoxRetentionPolicy.Info policyInfo : policies) {
7878
Get Retention Policy Assignments
7979
--------------
8080

81-
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].
81+
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].
8282
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].
8383

8484
```java
@@ -100,7 +100,7 @@ for (BoxRetentionPolicyAssignments.Info assignmentInfo : enterpriseAssignments)
100100
[get-all-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getAllAssignments-java.lang.String...-
101101
[get-all-assignments-with-params]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getAllAssignments-int-java.lang.String...-
102102
[get-folder-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getFolderAssignments-int-java.lang.String...-
103-
[get-enterprise-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getEnterpiseAssignments-int-java.lang.String...-
103+
[get-enterprise-assignments]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxRetentionPolicy.html#getEnterpriseAssignments-int-java.lang.String...-
104104

105105
Create Retention Policy Assignment
106106
--------------
@@ -143,7 +143,7 @@ BoxFileVersionRetention.Info policyInfo = policy.getInfo();
143143
Get File Version Retentions
144144
--------------
145145

146-
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].
146+
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].
147147

148148
```java
149149
BoxFileVersionRetention.QueryFilter filter = new BoxFileVersionRetention.QueryFilter()
@@ -160,6 +160,6 @@ for (BoxFileVersionRetention.Info retentionInfo : retentions) {
160160
}
161161
```
162162

163-
[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...-
164-
[query-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.html#QueryFilter
165-
[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...-
163+
[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...-
164+
[query-filter]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFileVersionRetention.QueryFilter.html
165+
[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...-

doc/tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,4 @@ BoxTaskAssignment.Info info = taskAssignment.getInfo();
128128
taskAssignment.updateInfo(info);
129129
```
130130

131-
[update-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxTaskAssignment.html#updateInfo-com.box.sdk.BoxTask.Info-
131+
[update-assignment]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxTaskAssignment.html#updateInfo-com.box.sdk.BoxTaskAssignment.Info-

doc/terms_of_service.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ If they have then you will need to make the update call.
9393
Accept or decline a Terms of Service for existing user
9494
------------------------------------------------------
9595

96-
For an existing user you can accept or decline a terms of service by calling [`updateInfo(BoxTermsOfService.Info)``][update-user-status]
96+
For an existing user you can accept or decline a terms of service by calling [`updateInfo(BoxTermsOfService.Info)`][update-user-status]
9797

9898
```java
9999
BoxTermsOfServiceUserStatus tosUserStatus = new BoxTermsOfServiceUserStatus(api, "tos-user-status-id");
@@ -107,7 +107,7 @@ tosUserStatus.updateInfo(tosUSerStatusInfo);
107107
Get User Status on a Terms of service
108108
-------------------------------------
109109

110-
You can retrieve the terms of service status for a user by calling[`getInfo(BoxApiConnection, String, String)``][get-user-status1]
110+
You can retrieve the terms of service status for a user by calling[`getInfo(BoxApiConnection, String, String)`][get-user-status1]
111111

112112
```java
113113
List<BoxTermsOfServiceUserStatus.Info> tosUserStatusInfo = BoxTermsOfServiceUserStatus.getInfo(api, "tos-id", "user-id");
@@ -116,7 +116,7 @@ for(BoxTermsOfServiceUserStatus.Info info : toUserStatusInfo){
116116
}
117117
```
118118

119-
Alternatively you can get the user status by the ID of the terms of service by calling[`getInfo(BoxApiConnection, String)``][get-user-status2]
119+
Alternatively you can get the user status by the ID of the terms of service by calling[`getInfo(BoxApiConnection, String)`][get-user-status2]
120120

121121
```java
122122
List<BoxTermsOfServiceUserStatus.Info> tosUserStatusInfo = BoxTermsOfServiceUserStatus.getInfo(api, "tos-id");

doc/users.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,16 @@ Users represent an individual's account on Box.
1919
Get the Current User's Information
2020
----------------------------------
2121

22-
To get the current user, call the static [`getCurrentUser(BoxAPIConnection)`]
23-
[get-current-user] method. Then use [`getInfo()`][get-info] to get information
24-
about the user.
22+
To get the current user, call the static [`getCurrentUser(BoxAPIConnection)`][get-current-user] method.
23+
Then use [`getInfo(String...)`][get-info] to get information about the user.
2524

2625
```java
2726
BoxUser user = BoxUser.getCurrentUser(api);
2827
BoxUser.Info info = user.getInfo();
2928
```
3029

3130
[get-current-user]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getCurrentUser-com.box.sdk.BoxAPIConnection-
32-
[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getInfo--
31+
[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxUser.html#getInfo-java.lang.String...-
3332

3433
Create An Enterprise User
3534
-------------------------

doc/webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ info.addPendingChange("address", url);
7272
webhook.update(info);
7373
```
7474

75-
[update]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxWebHook.html#update-com.box.sdk.BoxWebHook.Info-
75+
[update]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxWebHook.html#updateInfo-com.box.sdk.BoxWebHook.Info-

0 commit comments

Comments
 (0)