Skip to content

Commit 4d40424

Browse files
committed
Adds javadoc plugin in CI/CD
1 parent 584e6e6 commit 4d40424

50 files changed

Lines changed: 100 additions & 109 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

pom.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,23 @@
8787
</configuration>
8888
</plugin>
8989

90+
<plugin>
91+
<groupId>org.apache.maven.plugins</groupId>
92+
<artifactId>maven-javadoc-plugin</artifactId>
93+
<version>3.10.0</version>
94+
<executions>
95+
<execution>
96+
<id>attach-javadocs</id>
97+
<goals>
98+
<goal>jar</goal>
99+
</goals>
100+
</execution>
101+
</executions>
102+
<configuration>
103+
<doclint>all,-missing</doclint>
104+
</configuration>
105+
</plugin>
106+
90107
</plugins>
91108
</build>
92109
</project>

src/main/java/pl/smsapi/BasicAuthClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import java.security.NoSuchAlgorithmException;
88

99
/**
10-
* @deprecated use {@link OAuthClient} instead
10+
* @deprecated use @link OAuthClient instead
1111
*/
1212
@Deprecated
1313
public class BasicAuthClient implements Client {

src/main/java/pl/smsapi/api/ActionFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ public abstract class ActionFactory {
1010
protected Proxy proxy;
1111

1212
/**
13-
* @deprecated use {@link ActionFactory(Client, Proxy)} instead
13+
* @deprecated use @link ActionFactory(Client, Proxy) instead
1414
*/
1515
@Deprecated
1616
public ActionFactory() {
1717
this.proxy = new ProxyNative("https://api.smsapi.pl/");
1818
}
1919

2020
/**
21-
* @deprecated use {@link ActionFactory(Client, Proxy)} instead
21+
* @deprecated use @link ActionFactory(Client, Proxy) instead
2222
*/
2323
@Deprecated
2424
public ActionFactory(Client client) {

src/main/java/pl/smsapi/api/ContactsFactory.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
import pl.smsapi.proxy.ProxyNative;
88

99
/**
10-
* @deprecated use {@link pl.smsapi.api.action.contacts.ContactsFactory()} or {@link pl.smsapi.api.action.contacts.groups.GroupsFactory()} instead
10+
* @deprecated use @link pl.smsapi.api.action.contacts.ContactsFactory() or @link pl.smsapi.api.action.contacts.groups.GroupsFactory() instead
1111
*/
1212
@Deprecated
1313
public class ContactsFactory extends ActionFactory {
1414

1515
/**
16-
* @deprecated use {@link ContactsFactory(Client, Proxy)} or {@link pl.smsapi.api.action.contacts.ContactsFactory(Client, Proxy)} instead
16+
* @deprecated use @link ContactsFactory(Client, Proxy) or @link pl.smsapi.api.action.contacts.ContactsFactory(Client, Proxy) instead
1717
*/
1818
@Deprecated
1919
public ContactsFactory(Client client) {
@@ -26,7 +26,7 @@ public ContactsFactory(Client client, Proxy proxy) {
2626
}
2727

2828
/**
29-
* @deprecated use {@link pl.smsapi.api.action.contacts.ContactsFactory#actionList()} instead
29+
* @deprecated use @link pl.smsapi.api.action.contacts.ContactsFactory#actionList() instead
3030
*/
3131
@Deprecated
3232
public ContactsContactList actionContactList() {
@@ -37,7 +37,7 @@ public ContactsContactList actionContactList() {
3737
}
3838

3939
/**
40-
* @deprecated use {@link pl.smsapi.api.action.contacts.ContactsFactory#actionGet(String)} instead
40+
* @deprecated use @link pl.smsapi.api.action.contacts.ContactsFactory#actionGet(String) instead
4141
*/
4242
@Deprecated
4343
public ContactsContactGet actionContactGet(String contactId) {
@@ -49,7 +49,7 @@ public ContactsContactGet actionContactGet(String contactId) {
4949
}
5050

5151
/**
52-
* @deprecated use {@link pl.smsapi.api.action.contacts.ContactsFactory#actionAdd()} instead
52+
* @deprecated use @link pl.smsapi.api.action.contacts.ContactsFactory#actionAdd() instead
5353
*/
5454
@Deprecated
5555
public ContactsContactAdd actionContactAdd() {
@@ -60,7 +60,7 @@ public ContactsContactAdd actionContactAdd() {
6060
}
6161

6262
/**
63-
* @deprecated use {@link pl.smsapi.api.action.contacts.ContactsFactory#actionDelete(String)} instead
63+
* @deprecated use @link pl.smsapi.api.action.contacts.ContactsFactory#actionDelete(String) instead
6464
*/
6565
@Deprecated
6666
public ContactsContactDelete actionContactDelete(String contactId) {
@@ -72,7 +72,7 @@ public ContactsContactDelete actionContactDelete(String contactId) {
7272
}
7373

7474
/**
75-
* @deprecated use {@link pl.smsapi.api.action.contacts.ContactsFactory#actionEdit(String)} instead
75+
* @deprecated use @link pl.smsapi.api.action.contacts.ContactsFactory#actionEdit(String) instead
7676
*/
7777
@Deprecated
7878
public ContactsContactEdit actionContactEdit(String contactId) {
@@ -84,7 +84,7 @@ public ContactsContactEdit actionContactEdit(String contactId) {
8484
}
8585

8686
/**
87-
* @deprecated use {@link GroupsFactory#actionList()} instead
87+
* @deprecated use @link GroupsFactory#actionList() instead
8888
*/
8989
@Deprecated
9090
public ContactsGroupList actionGroupList() {
@@ -95,7 +95,7 @@ public ContactsGroupList actionGroupList() {
9595
}
9696

9797
/**
98-
* @deprecated use {@link GroupsFactory#actionAdd(String)} ()} instead
98+
* @deprecated use @link GroupsFactory#actionAdd(String)} () instead
9999
*/
100100
@Deprecated
101101
public ContactsGroupAdd actionGroupAdd() {
@@ -106,7 +106,7 @@ public ContactsGroupAdd actionGroupAdd() {
106106
}
107107

108108
/**
109-
* @deprecated use {@link GroupsFactory#actionDelete(String)} ()} instead
109+
* @deprecated use @link GroupsFactory#actionDelete(String)} () instead
110110
*/
111111
@Deprecated
112112
public ContactsGroupDelete actionGroupDelete(String groupId) {
@@ -118,7 +118,7 @@ public ContactsGroupDelete actionGroupDelete(String groupId) {
118118
}
119119

120120
/**
121-
* @deprecated use {@link GroupsFactory#actionGet(String)} ()} instead
121+
* @deprecated use @link GroupsFactory#actionGet(String)} () instead
122122
*/
123123
@Deprecated
124124
public ContactsGroupGet actionGroupGet(String groupId) {
@@ -130,7 +130,7 @@ public ContactsGroupGet actionGroupGet(String groupId) {
130130
}
131131

132132
/**
133-
* @deprecated use {@link GroupsFactory#actionEdit(String)} ()} instead
133+
* @deprecated use @link GroupsFactory#actionEdit(String)} () instead
134134
*/
135135
@Deprecated
136136
public ContactsGroupEdit actionGroupEdit(String groupId) {

src/main/java/pl/smsapi/api/MmsFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
public class MmsFactory extends ActionFactory {
1010

1111
/**
12-
* @deprecated use {@link MmsFactory(Client, Proxy)} instead
12+
* @deprecated use @link MmsFactory(Client, Proxy) instead
1313
*/
1414
@Deprecated
1515
public MmsFactory(Client client) {

src/main/java/pl/smsapi/api/SenderFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
import pl.smsapi.proxy.Proxy;
99

1010
/**
11-
* @deprecated use {@link pl.smsapi.api.action.sms.sendernames.SendernamesFactory} instead
11+
* @deprecated use @link pl.smsapi.api.action.sms.sendernames.SendernamesFactory instead
1212
*/
1313
public class SenderFactory extends ActionFactory {
1414

1515
/**
16-
* @deprecated use {@link SenderFactory(Client, Proxy)} instead
16+
* @deprecated use @link SenderFactory(Client, Proxy) instead
1717
*/
1818
@Deprecated
1919
public SenderFactory(Client client) {

src/main/java/pl/smsapi/api/SmsFactory.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
public class SmsFactory extends ActionFactory {
1010

1111
/**
12-
* @deprecated use {@link SmsFactory(Client, Proxy)} instead
12+
* @deprecated use @link SmsFactory(Client, Proxy) instead
1313
*/
1414
@Deprecated
1515
public SmsFactory(Client client) {
@@ -21,7 +21,7 @@ public SmsFactory(Client client, Proxy proxy) {
2121
}
2222

2323
/**
24-
* @deprecated use {@link #actionSend(String, String)} or {@link #actionSend(String[], String)} instead
24+
* @deprecated use @link #actionSend(String, String)} or @link #actionSend(String[], String) instead
2525
*/
2626
@Deprecated
2727
public SMSSend actionSend() {
@@ -46,7 +46,7 @@ public SMSSend actionSend(String[] to, String text) {
4646
}
4747

4848
/**
49-
* @deprecated use {@link #actionGet(String)} instead
49+
* @deprecated use @link #actionGet(String) instead
5050
*/
5151
@Deprecated
5252
public SMSGet actionGet() {
@@ -64,7 +64,7 @@ public SMSGet actionGet(String id) {
6464
}
6565

6666
/**
67-
* @deprecated use {@link #actionDelete(String)} instead
67+
* @deprecated use @link #actionDelete(String) instead
6868
*/
6969
@Deprecated
7070
public SMSDelete actionDelete() {

src/main/java/pl/smsapi/api/UserFactory.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
public class UserFactory extends ActionFactory {
1212

1313
/**
14-
* @deprecated use {@link UserFactory(Client, Proxy)} instead
14+
* @deprecated use @link UserFactory(Client, Proxy) instead
1515
*/
1616
@Deprecated
1717
public UserFactory(Client client) {
@@ -23,7 +23,7 @@ public UserFactory(Client client, Proxy proxy) {
2323
}
2424

2525
/**
26-
* @deprecated use {@link SubusersFactory#actionList()} instead
26+
* @deprecated use @link SubusersFactory#actionList() instead
2727
*/
2828
@Deprecated
2929
public UserList actionList() {
@@ -34,7 +34,7 @@ public UserList actionList() {
3434
}
3535

3636
/**
37-
* @deprecated use {@link SubusersFactory#actionAdd(String, String)} ()} instead
37+
* @deprecated use @link SubusersFactory#actionAdd(String, String)} () instead
3838
*/
3939
@Deprecated
4040
public UserAdd actionAdd() {
@@ -45,7 +45,7 @@ public UserAdd actionAdd() {
4545
}
4646

4747
/**
48-
* @deprecated use {@link SubusersFactory#actionEdit(String)} ()} instead
48+
* @deprecated use @link SubusersFactory#actionEdit(String)} () instead
4949
*/
5050
@Deprecated
5151
public UserEdit actionEdit(String username) {

src/main/java/pl/smsapi/api/VmsFactory.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
public class VmsFactory extends ActionFactory {
1313

1414
/**
15-
* @deprecated use {@link VmsFactory(Client, Proxy)} instead
15+
* @deprecated use @link VmsFactory(Client, Proxy) instead
1616
*/
1717
@Deprecated
1818
public VmsFactory(Client client) {
@@ -24,8 +24,8 @@ public VmsFactory(Client client, Proxy proxy) {
2424
}
2525

2626
/**
27-
* @deprecated use {@link #actionSend(String, String)} or {@link #actionSend(String[], String)}
28-
* or {@link #actionSend(String, File)} or {@link #actionSend(String[], File)} instead
27+
* @deprecated use @link #actionSend(String, String)} or @link #actionSend(String[], String)}
28+
* or @link #actionSend(String, File)} or @link #actionSend(String[], File) instead
2929
*/
3030
public VMSSend actionSend() {
3131
VMSSend action = new VMSSend();
@@ -67,7 +67,7 @@ public VMSSend actionSend(String[] to, File file) throws IOException {
6767
}
6868

6969
/**
70-
* @deprecated use {@link #actionGet(String)} instead
70+
* @deprecated use @link #actionGet(String) instead
7171
*/
7272
public VMSGet actionGet() {
7373
VMSGet action = new VMSGet();
@@ -84,7 +84,7 @@ public VMSGet actionGet(String id) {
8484
}
8585

8686
/**
87-
* @deprecated use {@link #actionDelete(String)} instead
87+
* @deprecated use @link #actionDelete(String) instead
8888
*/
8989
public VMSDelete actionDelete() {
9090
VMSDelete action = new VMSDelete();

src/main/java/pl/smsapi/api/action/AbstractSendAction.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ public T setGroup(String group) {
4040

4141
/**
4242
* Set scheduled date sending message.
43-
* <p/>
4443
* Setting a past date will result in sending message instantly.
4544
*/
4645
public T setDateSent(String date) {
@@ -50,7 +49,6 @@ public T setDateSent(String date) {
5049

5150
/**
5251
* Set scheduled date sending message.
53-
* <p/>
5452
* Setting a past date will result in sending message instantly.
5553
*/
5654
public T setDateSent(long date) {
@@ -60,7 +58,6 @@ public T setDateSent(long date) {
6058

6159
/**
6260
* Set scheduled date sending message.
63-
* <p/>
6461
* Setting a past date will result in sending message instantly.
6562
*/
6663
public T setDateSent(Calendar cal) {
@@ -85,7 +82,6 @@ public T setIDx(String[] idx) {
8582

8683
/**
8784
* Set checking idx is unique.
88-
* <p/>
8985
* Prevents from sending more than one message with the same idx.
9086
* When this parameter is set and message with the same idx was already sent error 53 is returned.
9187
*/

0 commit comments

Comments
 (0)