Skip to content

Commit 86b82f2

Browse files
author
Matt Willer
authored
Fix malformed links in docs (#527)
1 parent f216cca commit 86b82f2

18 files changed

+227
-228
lines changed

doc/collaboration_whitelists.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,108 +24,108 @@ parameter determines which way the whitelisting applies. You can set the value t
2424
BoxCollaborationWhitelist.create(api, "test.com", BoxCollaborationWhitelist.WhitelistDirection.BOTH);
2525
```
2626

27-
[whitelist1]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelist.html#create(com.box.sdk.BoxAPIConnection, %20java.lang.String, %20com.box.sdk.BoxCollaborationWhitelist.WhitelistDirection)
27+
[whitelist1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelist.html#create-com.box.sdk.BoxAPIConnection-java.lang.String-com.box.sdk.BoxCollaborationWhitelist.WhitelistDirection-
2828

2929
Get a Collaboration Whitelist's Information for a Domain
3030
--------------------------------------------------------
3131

3232
A specific collaboration whitelist for a domain can be retrieved with
33-
[`getInfo()`][getInfo]
33+
[`getInfo()`][getWhitelistInfo]
3434

3535
```java
3636
BoxCollaborationWhitelist domainWhitelist = new BoxCollaborationWhitelist(api, "id");
3737
domainWhitelist.getInfo();
3838
```
3939

40-
[getInfo]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelist.html#getInfo()
40+
[getWhitelistInfo]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelist.html#getInfo--
4141

4242
Get all Collaboration Whitelist's Information for Domain
4343
--------------------------------------------------------
4444

4545
All domain collaboration whitelists associated with an enterprise can be retrieved with
46-
[`getAll(BoxAPIConnection)`][getAll1]
46+
[`getAll(BoxAPIConnection)`][getAllWhitelists1]
4747

4848
```java
4949
BoxCollaborationWhitelist.getAll(api);
5050
```
5151

5252
To specify the number of whitelists to retrieve you can specify a limit on how many whitelists to return.
53-
[`getAll(BoxAPIConnection, Integer)`]
53+
[`getAll(BoxAPIConnection, Integer)`][getAllWhitelists2]
5454

5555
```java
5656
BoxCollaborationWhitelist.getAll(api, 10);
5757
```
5858

59-
[getAll1]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelist.html#getAll(com.box.sdk.BoxAPIConnection)
60-
[getAll2]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelist.html#getAll(com.box.sdk.BoxAPIConnection, %20java.lang.Integer)
59+
[getAllWhitelists1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelist.html#getAll-com.box.sdk.BoxAPIConnection-java.lang.String...-
60+
[getAllWhitelists2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelist.html#getAll-com.box.sdk.BoxAPIConnection-int-java.lang.String...-
6161

6262
Remove a Collaboration Whitelist for a Domain
6363
---------------------------------------------
6464

6565
To remove a collaboration whitelist you can call
66-
[`delete()`][delete]
66+
[`delete()`][deleteWhitelist]
6767

6868
```java
6969
BoxCollaborationWhitelist domainToBeDeleted = new BoxCollaborationWhitelist(api, "whitelist-id");
7070
domainToBeDeleted.delete();
7171
```
7272

73-
[delete]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelist.html#delete()
73+
[deleteWhitelist]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelist.html#delete--
7474

7575
Add a Collaboration Whitelist for a User
7676
----------------------------------------
7777

7878
A collaboration whitelist can be created for a user with
79-
[`create(BoxAPIConnection, String)`][create]
79+
[`create(BoxAPIConnection, String)`][createExempt]
8080

8181
```java
8282
String userID = "12345";
8383
BoxCollaborationWhitelistExemptTarget.create(api, userID);
8484
```
8585

86-
[create]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelistExemptTarget.html#create(com.box.sdk.BoxAPIConnection, %20java.lang.String)
86+
[createExempt]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelistExemptTarget.html#create-com.box.sdk.BoxAPIConnection-java.lang.String-
8787

8888
Get a Collaboration Whitelist's Information for a User
8989
------------------------------------------------------
9090

9191
To retrieve information regarding a specific user collaboration whitelist use
92-
[`getInfo()`][getInfo]
92+
[`getInfo()`][getInfoExempt]
9393

9494
```java
9595
BoxCollaborationWhitelistExemptTarget userWhitelist = new BoxCollaborationWhitelistExemptTarget(api, "whitelistID");
9696
userWhitelist.getInfo();
9797
```
9898

99-
[getInfo]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelistExemptTarget.html#getInfo()
99+
[getInfoExempt]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelistExemptTarget.html#getInfo--
100100

101101
Get all Collaboration Whitelist's Information for a User
102102
--------------------------------------------------------
103103

104104
To retrieve information regarding all user whitelists associated with an enterprise use
105-
[`getAll(BoxAPIConnection)`][getAll1]
105+
[`getAll(BoxAPIConnection)`][getAllExempt1]
106106

107107
```java
108108
BoxCollaborationWhitelistExemptTarget.getAll(api);
109109
```
110110

111111
Alternatively you can specify the number of user whitelists to return with one request with
112-
[`getAll(BoxApiConnection, Integer)`][getAll2]
112+
[`getAll(BoxApiConnection, Integer)`][getAllExempt2]
113113

114114
```java
115115
BoxCollaborationWhitelistExemptTarget.getAll(api, 5);
116116
```
117117

118-
[getAll1]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelistExemptTarget.html#getAll(com.box.sdk.BoxAPIConnection)
119-
[getAll2]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelistExemptTarget.html#getAll(com.box.sdk.BoxAPIConnection, %20java.lang.Integer)
118+
[getAllExempt1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelistExemptTarget.html#getAll-com.box.sdk.BoxAPIConnection-java.lang.String...-
119+
[getAllExempt2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelistExemptTarget.html#getAll-com.box.sdk.BoxAPIConnection-int-java.lang.String...-
120120

121121
Remove a Collaboration Whitelist for a User
122122
-------------------------------------------
123123

124124
To remove a user collaboration whitelist entry from an enterprise use
125-
[`delete()`][delete]
125+
[`delete()`][deleteExempt]
126126

127127
```java
128128
BoxCollaborationWhitelistExemptTarget.delete();
129129
```
130130

131-
[delete]: http://opensource.box.com/box-java-sdk/javadoc/com/sdk/BoxCollaborationWhitelistExemptTarget.html#delete()
131+
[deleteExempt]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaborationWhitelistExemptTarget.html#delete--

doc/collaborations.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ folder.collaborate(user, BoxCollaboration.Role.EDITOR);
2626
```
2727

2828
You can also add a collaboration by providing an email address with
29-
[`collaborate(String, BoxCollaboration.Role)`][collaborate2]. If the receipient
29+
[`collaborate(String, BoxCollaboration.Role)`][collaborate2]. If the recipient
3030
doesn't have a Box account, they will be asked create one.
3131

3232
```java
3333
BoxFolder folder = new BoxFile(api, "id");
3434
folder.collaborate("[email protected]", BoxCollaboration.Role.EDITOR);
3535
```
3636

37-
[collaborate1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFolder.html#collaborate(com.box.sdk.BoxCollaborator,%20com.box.sdk.BoxCollaboration.Role)
38-
[collaborate2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFolder.html#collaborate(java.lang.String,%20com.box.sdk.BoxCollaboration.Role)
37+
[collaborate1]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFolder.html#collaborate-com.box.sdk.BoxCollaborator-com.box.sdk.BoxCollaboration.Role-
38+
[collaborate2]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFolder.html#collaborate-java.lang.String-com.box.sdk.BoxCollaboration.Role-
3939

4040
Edit a Collaboration
4141
--------------------
@@ -52,7 +52,7 @@ collaboration.updateInfo(info);
5252
```
5353

5454
[box-collaboration-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.Info.html
55-
[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#updateInfo(com.box.sdk.BoxCollaboration.Info)
55+
[update-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#updateInfo-com.box.sdk.BoxCollaboration.Info-
5656

5757
Remove a Collaboration
5858
----------------------
@@ -64,7 +64,7 @@ BoxCollaboration collaboration = new BoxCollaboration(api, "id");
6464
collaboration.delete();
6565
```
6666

67-
[delete]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#delete()
67+
[delete]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#delete--
6868

6969
Get a Collaboration's Information
7070
---------------------------------
@@ -77,7 +77,7 @@ BoxCollaboration collaboration = new BoxCollaboration(api, "id");
7777
BoxCollaboration.Info info = collaboration.getInfo();
7878
```
7979

80-
[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#getInfo()
80+
[get-info]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#getInfo--
8181

8282
Get the Collaborations on a Folder
8383
----------------------------------
@@ -90,7 +90,7 @@ BoxFolder folder = new BoxFile(api, "id");
9090
Collection<BoxCollaboration.Info> collaborations = folder.getCollaborations();
9191
```
9292

93-
[get-collaborations]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFolder.html#getCollaborations()
93+
[get-collaborations]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxFolder.html#getCollaborations--
9494

9595
Get Pending Collaborations
9696
--------------------------
@@ -103,4 +103,4 @@ Collection<BoxCollaboration.Info> pendingCollaborations =
103103
BoxCollaboration.getPendingCollaborations(api);
104104
```
105105

106-
[get-pending-collaborations]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#getPendingCollaborations(com.box.sdk.BoxAPIConnection)
106+
[get-pending-collaborations]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollaboration.html#getPendingCollaborations-com.box.sdk.BoxAPIConnection-

doc/collections.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ for (BoxCollection.Info collectionInfo : collections) {
2525
}
2626
```
2727

28-
[get-collections]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollection.html#getAllCollections(com.box.sdk.BoxAPIConnection)
28+
[get-collections]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxCollection.html#getAllCollections-com.box.sdk.BoxAPIConnection-
2929

3030
Get a Collection's Items
3131
------------------------
@@ -48,13 +48,13 @@ for (BoxItem.Info itemInfo : folder) {
4848
}
4949
```
5050

51-
[iterator]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxCollection.html#iterator()
51+
[iterator]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxCollection.html#iterator--
5252

5353
Add Items to a Collection
5454
-------------------------
5555

5656
Add an item to a collection by calling
57-
[`setCollections(String...)`][set-collections] on any `BoxItem`. Note that this
57+
[`setCollections(BoxCollection...)`][set-collections] on any `BoxItem`. Note that this
5858
method will overwrite all collections that the item belongs to.
5959

6060
```java
@@ -73,7 +73,7 @@ Remove Items from a Collection
7373
------------------------------
7474

7575
Remove an item from a collection by calling
76-
[`setCollections(String...)`][set-collections] on any `BoxItem` and exclude the
76+
[`setCollections(BoxCollection...)`][set-collections] on any `BoxItem` and exclude the
7777
collection to wish to remove it from.
7878

7979
```java
@@ -91,4 +91,4 @@ for (BoxCollection.Info info : info.getCollections(api)) {
9191
file.setCollections(collections.toArray());
9292
```
9393

94-
[set-collections]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxItem.html#setCollections(java.lang.String...)
94+
[set-collections]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxItem.html#setCollections-com.box.sdk.BoxCollection...-

doc/comments.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ BoxComment comment = new BoxComment(api, "id");
2222
BoxComment.Info info = comment.getInfo();
2323
```
2424

25-
[get-info]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#getInfo()
25+
[get-info]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#getInfo--
2626

2727
Get the Comments on a File
2828
--------------------------
@@ -35,7 +35,7 @@ BoxFile file = new BoxFile(api, "id");
3535
List<BoxComment.Info> comments = file.getComments();
3636
```
3737

38-
[get-comments]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#getComments()
38+
[get-comments]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#getComments--
3939

4040
Add a Comment to a File
4141
-----------------------
@@ -59,7 +59,7 @@ BoxFile file = new BoxFile(api, "id");
5959
file.addComment("Message mentioning @[1234:[email protected]].");
6060
```
6161

62-
[add-comment]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#addComment(java.lang.String)
62+
[add-comment]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxFile.html#addComment-java.lang.String-
6363

6464
Reply to a Comment
6565
------------------
@@ -71,7 +71,7 @@ BoxComment comment = new BoxComment(api, "id");
7171
comment.reply("A reply to another comment.");
7272
```
7373

74-
[reply]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#reply(java.lang.String)
74+
[reply]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#reply-java.lang.String-
7575

7676
Change a Comment's Message
7777
--------------------------
@@ -84,7 +84,7 @@ BoxComment comment = new BoxComment(api, "id");
8484
comment.changeMessage("An edited message.");
8585
```
8686

87-
[change-message]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#changeMessage(java.lang.String)
87+
[change-message]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#changeMessage-java.lang.String-
8888

8989
Delete a Comment
9090
----------------
@@ -96,4 +96,4 @@ BoxComment comment = new BoxComment(api, "id");
9696
comment.delete();
9797
```
9898

99-
[delete]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#delete()
99+
[delete]: https://box.github.io/box-java-sdk/javadoc/com/box/sdk/BoxComment.html#delete--

doc/devices.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ Device pinning is a feature that allows enterprise admins to pin their user’s
1010
Get Enterprise Device Pins
1111
--------------------------
1212

13-
Calling the static [`getEnterpriceDevicePins(BoxAPIConnection, String, String...)`][get-enterprise-device-pins] will return an iterable that will page through all of the device pins belongs to enterprise with given id. It is possible to specify maximum number of retrieved items per single response calling [`getEnterpriceDevicePins(BoxAPIConnection, String, int, String...)`][get-enterprise-device-pins-with-limit]
13+
Calling the static [`getEnterpriceDevicePins(BoxAPIConnection, String, String...)`][get-enterprise-device-pins] will return
14+
an iterable that will page through all of the device pins belongs to enterprise with given id. It is possible to specify
15+
maximum number of retrieved items per single response calling
16+
[`getEnterpriceDevicePins(BoxAPIConnection, String, int, String...)`][get-enterprise-device-pins-with-limit]
1417

1518
```java
1619
Iterable<BoxDevicePin.Info> enterpriceDevicePins = BoxDevicePin.getEnterpriceDevicePins(api, id);
@@ -19,8 +22,8 @@ for (BoxDevicePin.Info devicePin : enterpriseDevicePins) {
1922
}
2023
```
2124

22-
[get-enterprise-device-pins]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#getEnterpriceDevicePins(com.box.sdk.BoxAPIConnection,%20java.lang.String,%20java.lang.String...)
23-
[get-enterprise-device-pins-with-limit]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#getEnterpriceDevicePins(com.box.sdk.BoxAPIConnection,%20java.lang.String,%20int,%20java.lang.String...)
25+
[get-enterprise-device-pins]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#getEnterpriceDevicePins-com.box.sdk.BoxAPIConnection-java.lang.String-java.lang.String...-
26+
[get-enterprise-device-pins-with-limit]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#getEnterpriceDevicePins-com.box.sdk.BoxAPIConnection-java.lang.String-int-java.lang.String...-
2427

2528
Get Device Pin
2629
--------------
@@ -33,7 +36,7 @@ BoxDevicePin devicePin = new BoxDevicePin(api, id);
3336
BoxDevicePin.Info devicePinInfo = devicePin.getInfo();
3437
```
3538

36-
[get-device-pin]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#getInfo(java.lang.String...)
39+
[get-device-pin]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#getInfo-java.lang.String...-
3740

3841
Delete Device Pin
3942
--------------
@@ -45,4 +48,4 @@ BoxDevicePin devicePin = new BoxDevicePin(api, id);
4548
devicePin.delete();
4649
```
4750

48-
[delete]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#delete()
51+
[delete]: http://opensource.box.com/box-java-sdk/javadoc/com/box/sdk/BoxDevicePin.html#delete--

0 commit comments

Comments
 (0)