Skip to content

Commit c1afcf9

Browse files
doc tags updated
1 parent a75dc62 commit c1afcf9

File tree

4 files changed

+39
-19
lines changed

4 files changed

+39
-19
lines changed

pom.xml

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,29 @@
2121
</licenses>
2222

2323
<developers>
24+
2425
<developer>
2526
<name>Shailesh Mishra</name>
2627
<email>mshaileshr@gmail.com</email>
2728
<organization>Contentstack</organization>
2829
<organizationUrl>https://www.contentstack.com/</organizationUrl>
2930
</developer>
31+
32+
<developer>
33+
<name>Contentstacksdk</name>
34+
<email>mobile@contentstack.com</email>
35+
<organization>Contentstack</organization>
36+
<organizationUrl>https://www.contentstack.com/</organizationUrl>
37+
</developer>
38+
3039
</developers>
3140

3241

3342
<scm>
3443
<url>https://github.com/contentstack/contentstack-java/tree/master</url>
3544
<connection>scm:git:git://github.com/contentstack/contentstack-java.git</connection>
3645
<developerConnection>scm:git:ssh://github.com:contentstack/contentstack-java.git</developerConnection>
37-
<tag>v@{project.version}</tag>
46+
<tag>v1.2.1</tag>
3847
</scm>
3948

4049
<issueManagement>
@@ -50,14 +59,17 @@
5059

5160

5261
<distributionManagement>
62+
5363
<snapshotRepository>
5464
<id>ossrh</id>
5565
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
5666
</snapshotRepository>
67+
5768
<repository>
5869
<id>ossrh</id>
5970
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
6071
</repository>
72+
6173
</distributionManagement>
6274

6375

@@ -67,6 +79,7 @@
6779

6880

6981
<dependencies>
82+
7083
<dependency>
7184
<groupId>junit</groupId>
7285
<artifactId>junit</artifactId>
@@ -84,6 +97,7 @@
8497

8598
<build>
8699
<plugins>
100+
87101
<plugin>
88102
<groupId>org.apache.maven.plugins</groupId>
89103
<artifactId>maven-source-plugin</artifactId>
@@ -97,10 +111,14 @@
97111
</execution>
98112
</executions>
99113
</plugin>
114+
100115
<plugin>
101116
<groupId>org.apache.maven.plugins</groupId>
102117
<artifactId>maven-javadoc-plugin</artifactId>
103118
<version>2.9.1</version>
119+
<configuration>
120+
<additionalparam>-Xdoclint:none</additionalparam>
121+
</configuration>
104122
<executions>
105123
<execution>
106124
<id>attach-javadocs</id>
@@ -137,15 +155,15 @@
137155
</plugin>
138156

139157
<plugin>
140-
<groupId>org.sonatype.plugins</groupId>
141-
<artifactId>nexus-staging-maven-plugin</artifactId>
142-
<version>1.6.7</version>
143-
<extensions>true</extensions>
144-
<configuration>
145-
<serverId>ossrh</serverId>
146-
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
147-
<autoReleaseAfterClose>true</autoReleaseAfterClose>
148-
</configuration>
158+
<groupId>org.sonatype.plugins</groupId>
159+
<artifactId>nexus-staging-maven-plugin</artifactId>
160+
<version>1.6.7</version>
161+
<extensions>true</extensions>
162+
<configuration>
163+
<serverId>ossrh</serverId>
164+
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
165+
<autoReleaseAfterClose>true</autoReleaseAfterClose>
166+
</configuration>
149167
</plugin>
150168

151169
<plugin>
@@ -159,6 +177,7 @@
159177
<goals>deploy</goals>
160178
</configuration>
161179
</plugin>
180+
162181
</plugins>
163182
</build>
164183

src/main/java/com/contentstack/sdk/Config.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public class Config {
2323
public Config(){}
2424

2525
/**
26-
* Sets host name of the Built.io Contentstack server.
26+
* Sets host name of the Contentstack server.
2727
*
2828
* @param hostName
2929
* host name.
@@ -44,10 +44,10 @@ public void setHost(String hostName){
4444
}
4545

4646

47+
4748
/**
48-
* Get URL.
49-
*
5049
*
50+
* @return URL String
5151
* <br><br><b>Example :</b><br>
5252
* <pre class="prettyprint">
5353
* String url = config.getHost();
@@ -59,8 +59,8 @@ public String getHost(){
5959

6060

6161
/**
62-
* Get version of the Built.io Contentstack server.
63-
*
62+
* Get version of the Contentstack server.
63+
* @return VERSION String
6464
* <br><br><b>Example :</b><br>
6565
* <pre class="prettyprint">
6666
* String version = config.getVersion();
@@ -71,7 +71,7 @@ public String getVersion(){
7171
}
7272

7373
/**
74-
* Changes the Built.io Contentstack version to be used in the final URL.
74+
* Changes the Contentstack version to be used in the final URL.
7575
*
7676
* @param version
7777
* version string.
@@ -92,8 +92,7 @@ private void setVersion(String version){
9292
/**
9393
* set environment.
9494
*
95-
* @param environment
96-
* environment uid/name
95+
* @param environment uid/name
9796
*
9897
* <br><br><b>Example :</b><br>
9998
* <pre class="prettyprint">
@@ -109,6 +108,7 @@ protected void setEnvironment(String environment){
109108

110109
/**
111110
* Get environment.
111+
* @return param environment string
112112
* <br><br><b>Example :</b><br>
113113
* <pre class="prettyprint">
114114
* String environment = config.getEnvironment();

src/main/java/com/contentstack/sdk/ContentType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ public Query query(){
145145
/**
146146
*
147147
*
148-
* @param callback ContentTypesCallback
148+
* @return callback ContentTypesCallback
149149
* This call returns information of a specific content type. It returns the content type schema, but does not include its entries.
150150
*
151151
* <br><br><b>Example :</b><br>

src/main/java/com/contentstack/sdk/Query.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ public void setHeader(String key, String value){
8282

8383
/**
8484
* Remove header key @param key custom_header_key
85+
* @return key string
8586
* <br><br><b>Example :</b><br>
8687
* <pre class="prettyprint">
8788
* //'blt5d4sample2633b' is a dummy Stack API key

0 commit comments

Comments
 (0)