Skip to content

Commit d7682bf

Browse files
committed
1. Added Javadoc into AbstractReference.
2. Replaced Javadoc with Override for GenbankReference.
1 parent a2ac8f5 commit d7682bf

File tree

2 files changed

+45
-27
lines changed

2 files changed

+45
-27
lines changed

biojava-core/src/main/java/org/biojava/nbio/core/sequence/reference/AbstractReference.java

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,76 @@
55
*/
66
public abstract class AbstractReference implements ReferenceInterface {
77

8+
/**
9+
* The title that retrieved from the Reference section.
10+
*/
811
private String title;
912

13+
/**
14+
* The authors are a list of Inventors that retrieved from the Reference section.
15+
*/
1016
private String authors;
1117

18+
/**
19+
* The journal usually contains the Publication Number, Publication Date and Assignee
20+
*/
1221
private String journal;
1322

23+
/**
24+
* The title that retrieved from the Reference section.
25+
*
26+
* @return
27+
*/
1428
@Override
1529
public String getTitle() {
1630
return title;
1731
}
1832

33+
/**
34+
* Set The title that retrieved from the Reference section.
35+
*
36+
* @param title
37+
*/
1938
@Override
2039
public void setTitle(String title) {
2140
this.title = title;
2241
}
2342

43+
/**
44+
* The authors are a list of Inventors that retrieved from the Reference section.
45+
*
46+
* @return
47+
*/
2448
@Override
2549
public String getAuthors() {
2650
return authors;
2751
}
2852

53+
/**
54+
* Set The authors are a list of Inventors that retrieved from the Reference section.
55+
*
56+
* @param authors
57+
*/
2958
@Override
3059
public void setAuthors(String authors) {
3160
this.authors = authors;
3261
}
3362

63+
/**
64+
* The journal usually contains the Publication Number, Publication Date and Assignee
65+
*
66+
* @return
67+
*/
3468
@Override
3569
public String getJournal() {
3670
return journal;
3771
}
3872

73+
/**
74+
* Set The journal usually contains the Publication Number, Publication Date and Assignee
75+
*
76+
* @param journal
77+
*/
3978
@Override
4079
public void setJournal(String journal) {
4180
this.journal = journal;

biojava-core/src/main/java/org/biojava/nbio/core/sequence/reference/GenbankReference.java

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,59 +7,38 @@
77
*/
88
public class GenbankReference extends AbstractReference {
99

10-
/**
11-
* The authors are a list of Inventors that retrieved from the Reference section.
12-
*/
1310
private String authors;
1411

15-
/**
16-
* The title that retrieved from the Reference section.
17-
*/
1812
private String title;
1913

20-
/**
21-
* The journal usually contains the Publication Number, Publication Date and Assignee
22-
*/
2314
private String journal;
2415

25-
/**
26-
* @return
27-
*/
16+
@Override
2817
public String getAuthors() {
2918
return authors;
3019
}
3120

32-
/**
33-
* @param authors
34-
*/
21+
@Override
3522
public void setAuthors(String authors) {
3623
this.authors = authors;
3724
}
3825

39-
/**
40-
* @return
41-
*/
26+
@Override
4227
public String getTitle() {
4328
return title;
4429
}
4530

46-
/**
47-
* @param title
48-
*/
31+
@Override
4932
public void setTitle(String title) {
5033
this.title = title;
5134
}
5235

53-
/**
54-
* @return
55-
*/
36+
@Override
5637
public String getJournal() {
5738
return journal;
5839
}
5940

60-
/**
61-
* @param journal
62-
*/
41+
@Override
6342
public void setJournal(String journal) {
6443
this.journal = journal;
6544
}

0 commit comments

Comments
 (0)