Skip to content

Commit bec048d

Browse files
committed
more javadoc comments.
1 parent 57f981b commit bec048d

File tree

4 files changed

+157
-5
lines changed

4 files changed

+157
-5
lines changed

library/src/main/java/io/syslogic/github/api/model/Repositories.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@
1414
*/
1515
public class Repositories extends BaseModel {
1616

17+
/** Items */
1718
@SerializedName("items")
1819
private ArrayList<Repository> mItems;
1920

21+
/** Item Count */
2022
@SerializedName("total_count")
2123
private Long totalCount;
2224

library/src/main/java/io/syslogic/github/api/model/Repository.java

Lines changed: 148 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,185 +114,331 @@ public Repository(@NonNull Long id, @NonNull String name, @NonNull String url) {
114114
this.setUrl(url);
115115
}
116116

117-
/* Setters */
117+
/**
118+
* Setter for id.
119+
* @param value the id of the repository.
120+
*/
118121
public void setId(@NonNull Long value) {
119122
this.id = value;
120123
}
121124

125+
/**
126+
* Setter for nodeId.
127+
* @param value the nodeId of the repository.
128+
*/
122129
public void setNodeId(@NonNull String value) {
123130
this.nodeId = value;
124131
}
125132

133+
/**
134+
* Setter for name.
135+
* @param value the name of the repository.
136+
*/
126137
public void setName(@NonNull String value) {
127138
this.name = value;
128139
}
129140

141+
/**
142+
* Setter for fullName.
143+
* @param value the fullName of the repository.
144+
*/
130145
public void setFullName(@NonNull String value) {
131146
this.fullName = value;
132147
}
133148

149+
/**
150+
* Setter for fileName.
151+
* @param value the file-name of the repository.
152+
*/
134153
public void setFileName(@NonNull String value) {
135154
this.fileName = value;
136155
}
137156

157+
/**
158+
* Setter for url.
159+
* @param value the url of the repository.
160+
*/
138161
public void setUrl(@NonNull String value) {
139162
this.url = value;
140163
}
141164

165+
/**
166+
* Setter for htmlUrl.
167+
* @param value the htmlUrl of the repository.
168+
*/
142169
public void setHtmlUrl(@NonNull String value) {
143170
this.htmlUrl = value;
144171
}
145172

173+
/**
174+
* Setter for owner.
175+
* @param value the owner of the repository.
176+
*/
146177
public void setOwner(@NonNull Owner value) {
147178
this.owner = value;
148179
}
149180

181+
/**
182+
* Setter for ownerId.
183+
* @param value the ownerId of the repository.
184+
*/
150185
public void setOwnerId(@NonNull Long value) {
151186
this.ownerId = value;
152187
}
153188

189+
/**
190+
* Setter for license.
191+
* @param value the license of the repository.
192+
*/
154193
public void setLicense(@NonNull License value) {
155194
this.license = value;
156195
}
157196

197+
/**
198+
* Setter for licenseId.
199+
* @param value the licenseId of the repository.
200+
*/
158201
public void setLicenseId(@NonNull Long value) {
159202
this.licenseId = value;
160203
}
161204

205+
/**
206+
* Setter for forkCount.
207+
* @param value the fork-count of the repository.
208+
*/
162209
public void setForkCount(@NonNull Long value) {
163210
this.forkCount = value;
164211
}
165212

213+
/**
214+
* Setter for stargazerCount.
215+
* @param value the stargazer-count of the repository.
216+
*/
166217
public void setStargazerCount(@NonNull Long value) {
167218
this.stargazerCount = value;
168219
}
169220

221+
/**
222+
* Setter for watcherCount.
223+
* @param value the watcher-count of the repository.
224+
*/
170225
public void setWatcherCount(@NonNull Long value) {
171226
this.watcherCount = value;
172227
}
173228

229+
/**
230+
* Setter for subscriberCount.
231+
* @param value the subscriber-count of the repository.
232+
*/
174233
public void setSubscriberCount(@NonNull Long value) {
175234
this.subscriberCount = value;
176235
}
177236

237+
/**
238+
* Setter for networkCount.
239+
* @param value the network-count of the repository.
240+
*/
178241
public void setNetworkCount(@NonNull Long value) {
179242
this.networkCount = value;
180243
}
181244

245+
/**
246+
* Setter for topics.
247+
* @param value the topics of the repository.
248+
*/
182249
public void setTopics(@NonNull String[] value) {
183250
this.topics = value;
184251
}
185252

253+
/**
254+
* Setter for workflows.
255+
* @param value the workflows of the repository.
256+
*/
186257
public void setWorkflows(@NonNull ArrayList<Workflow> value) {
187258
this.workflows = value;
188259
}
189260

190-
/* Getters */
261+
/**
262+
* Getter for id.
263+
* @return the ID of the repository.
264+
*/
191265
@NonNull
192266
@Bindable
193267
public Long getId() {
194268
return this.id;
195269
}
196270

271+
/**
272+
* Getter for nodeId.
273+
* @return the nodeId of the repository.
274+
*/
197275
@NonNull
198276
@Bindable
199277
public String getNodeId() {
200278
return this.nodeId;
201279
}
202280

281+
/**
282+
* Getter for name.
283+
* @return the name of the repository.
284+
*/
203285
@NonNull
204286
@Bindable
205287
public String getName() {
206288
return this.name;
207289
}
208290

291+
/**
292+
* Getter for fileName.
293+
* @return the file-name of the repository.
294+
*/
209295
@NonNull
210296
@Bindable
211297
public String getFileName() {
212298
return this.fileName;
213299
}
214300

301+
/**
302+
* Getter for fullName.
303+
* @return the full name of the repository.
304+
*/
215305
@NonNull
216306
@Bindable
217307
public String getFullName() {
218308
return this.fullName;
219309
}
220310

311+
/**
312+
* Getter for url.
313+
* @return the url of the repository.
314+
*/
221315
@NonNull
222316
@Bindable
223317
public String getUrl() {
224318
return this.url;
225319
}
226320

321+
/**
322+
* Getter for htmlUrl.
323+
* @return the htmlUrl of the repository.
324+
*/
227325
@NonNull
228326
@Bindable
229327
public String getHtmlUrl() {
230328
return this.htmlUrl;
231329
}
232330

331+
/**
332+
* Getter for owner.
333+
* @return the owner of the repository.
334+
*/
233335
@NonNull
234336
@Bindable
235337
public Owner getOwner() {
236338
return this.owner;
237339
}
238340

341+
/**
342+
* Getter for ownerId.
343+
* @return the ownerId of the repository.
344+
*/
239345
@NonNull
240346
public Long getOwnerId() {
241347
return this.ownerId;
242348
}
243349

350+
/**
351+
* Getter for license.
352+
* @return the license of the repository.
353+
*/
244354
@NonNull
245355
@Bindable
246356
public License getLicense() {
247357
return this.license;
248358
}
249359

360+
/**
361+
* Getter for licenseId.
362+
* @return the licenseId of the repository.
363+
*/
250364
@NonNull
251365
public Long getLicenseId() {
252366
return this.licenseId;
253367
}
254368

369+
/**
370+
* Getter for forkCount.
371+
* @return the fork-count of the repository.
372+
*/
255373
@NonNull
256374
@Bindable
257375
public Long getForkCount() {
258376
return this.forkCount;
259377
}
260378

379+
/**
380+
* Getter for forkCount.
381+
* @return the fork-count of the repository.
382+
*/
261383
@NonNull
262384
@Bindable
263385
public Long getStargazerCount() {
264386
return this.stargazerCount;
265387
}
266388

389+
/**
390+
* Getter for forkCount.
391+
* @return the fork-count of the repository.
392+
*/
267393
@NonNull
268394
@Bindable
269395
public Long getWatcherCount() {
270396
return this.watcherCount;
271397
}
272398

399+
/**
400+
* Getter for forkCount.
401+
* @return the fork-count of the repository.
402+
*/
273403
@NonNull
274404
@Bindable
275405
public Long getSubscriberCount() {
276406
return this.subscriberCount;
277407
}
278408

409+
/**
410+
* Getter for forkCount.
411+
* @return the fork-count of the repository.
412+
*/
279413
@NonNull
280414
@Bindable
281415
public Long getNetworkCount() {
282416
return this.networkCount;
283417
}
284418

419+
/**
420+
* Getter for topics.
421+
* @return the topics of the repository.
422+
*/
285423
@NonNull
286424
@Bindable
287425
public String[] getTopics() {
288426
return this.topics;
289427
}
290428

429+
/**
430+
* Getter for workflows.
431+
* @return the workflows of the repository.
432+
*/
291433
@NonNull
292434
public ArrayList<Workflow> getWorkflows() {
293435
return this.workflows;
294436
}
295437

438+
/**
439+
* Getter for workflowCount.
440+
* @return the total count of workflows in the repository.
441+
*/
296442
@Bindable
297443
public int getWorkflowCount() {
298444
return this.workflows.size();

library/src/main/java/io/syslogic/github/api/model/RepositorySearch.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@
1414
*/
1515
public class RepositorySearch extends BaseModel {
1616

17+
/** Items */
1718
@SerializedName("items")
1819
private ArrayList<Repository> mItems;
1920

21+
/** Item Count */
2022
@SerializedName("total_count")
2123
private Long totalCount;
2224

library/src/main/java/io/syslogic/github/api/model/WorkflowsResponse.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@
1414
*/
1515
public class WorkflowsResponse {
1616

17-
@SerializedName("total_count")
18-
private Long totalCount = 0L;
19-
17+
/** Items */
2018
@SerializedName("workflows")
2119
private ArrayList<Workflow> workflows;
2220

21+
/** Item Count */
22+
@SerializedName("total_count")
23+
private Long totalCount = 0L;
24+
2325
/**
2426
* Setter for totalCount.
2527
* @param value the total count of workflows.

0 commit comments

Comments
 (0)