1 package net.sourceforge.jenesis4java;
2
3 /*
4 * #%L
5 * Jenesis 4 Java Code Generator
6 * %%
7 * Copyright (C) 2000 - 2015 jenesis4java
8 * %%
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * #L%
23 */
24
25 import java.util.List;
26
27 /**
28 * Copyright (C) 2008, 2010 Richard van Nieuwenhoven - ritchie [at] gmx [dot] at
29 * Copyright (C) 2000, 2001 Paul Cody Johnston - pcj@inxar.org <br>
30 * This file is part of Jenesis4java. Jenesis4java is free software: you can
31 * redistribute it and/or modify it under the terms of the GNU Lesser General
32 * Public License as published by the Free Software Foundation, either version 3
33 * of the License, or (at your option) any later version.<br>
34 * Jenesis4java is distributed in the hope that it will be useful, but WITHOUT
35 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
36 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
37 * details.<br>
38 * You should have received a copy of the GNU Lesser General Public License
39 * along with Jenesis4java. If not, see <http://www.gnu.org/licenses/>.
40 */
41 /**
42 * {@code Comment} subinterface for documentation comments (javadoc).
43 */
44 public interface DocumentationComment extends Comment {
45
46 /**
47 * Adds a {@code param} tag to the list of {@code param} tags.
48 */
49 DocumentationComment addParam(String s);
50
51 /**
52 * Adds a {@code see} tag to the list of {@code see} tags.
53 */
54 DocumentationComment addSee(String s);
55
56 /**
57 * Returns the {@code author} tag.
58 */
59 String getAuthor();
60
61 /**
62 * Returns the {@code date} tag.
63 */
64 String getDate();
65
66 /**
67 * Returns the {@code deprecated} tag.
68 */
69 String getDeprecated();
70
71 /**
72 * Returns the {@code exception} tag.
73 */
74 String getException();
75
76 /**
77 * Returns an {@code List} of {@code String} over the list of {@code param}
78 * tags.
79 */
80 List<String> getParams();
81
82 /**
83 * Returns the {@code return} tag.
84 */
85 String getReturn();
86
87 /**
88 * Returns an {@code List} of {@code String} over the list of {@code see}
89 * tags.
90 */
91 List<String> getSees();
92
93 /**
94 * Returns the {@code serial} tag.
95 */
96 String getSerial();
97
98 /**
99 * Returns the {@code serialData} tag.
100 */
101 String getSerialData();
102
103 /**
104 * Returns the {@code serialField} tag.
105 */
106 String getSerialField();
107
108 /**
109 * Returns the {@code since} tag.
110 */
111 String getSince();
112
113 /**
114 * Returns the {@code throws} tag.
115 */
116 String getThrows();
117
118 /**
119 * Returns the {@code version} tag.
120 */
121 String getVersion();
122
123 /**
124 * Sets the {@code author} tag.
125 */
126 DocumentationComment setAuthor(String s);
127
128 /**
129 * Sets the {@code datew} tag.
130 */
131 DocumentationComment setDate(String s);
132
133 /**
134 * Sets the {@code deprecated} tag.
135 */
136 DocumentationComment setDeprecated(String s);
137
138 /**
139 * Sets the {@code exception} tag.
140 */
141 DocumentationComment setException(String s);
142
143 /**
144 * Sets the {@code return} tag.
145 */
146 DocumentationComment setReturn(String s);
147
148 /**
149 * Sets the {@code serial} tag.
150 */
151 DocumentationComment setSerial(String s);
152
153 /**
154 * Sets the {@code serialData} tag.
155 */
156 DocumentationComment setSerialData(String s);
157
158 /**
159 * Sets the {@code serialField} tag.
160 */
161 DocumentationComment setSerialField(String s);
162
163 /**
164 * Sets the {@code since} tag.
165 */
166 DocumentationComment setSince(String s);
167
168 /**
169 * Sets the {@code throws} tag.
170 */
171 DocumentationComment setThrows(String s);
172
173 /**
174 * Sets the {@code version} tag.
175 */
176 DocumentationComment setVersion(String s);
177 }