1 // Generated from com/puppycrawl/tools/checkstyle/grammar/javadoc/JavadocCommentsParser.g4 by ANTLR 4.13.2
2 package com.puppycrawl.tools.checkstyle.grammar.javadoc;
3 import org.antlr.v4.runtime.tree.ParseTreeVisitor;
4
5 /**
6 * This interface defines a complete generic visitor for a parse tree produced
7 * by {@link JavadocCommentsParser}.
8 *
9 * @param <T> The return type of the visit operation. Use {@link Void} for
10 * operations with no return type.
11 */
12 public interface JavadocCommentsParserVisitor<T> extends ParseTreeVisitor<T> {
13 /**
14 * Visit a parse tree produced by {@link JavadocCommentsParser#javadoc}.
15 * @param ctx the parse tree
16 * @return the visitor result
17 */
18 T visitJavadoc(JavadocCommentsParser.JavadocContext ctx);
19 /**
20 * Visit a parse tree produced by {@link JavadocCommentsParser#mainDescription}.
21 * @param ctx the parse tree
22 * @return the visitor result
23 */
24 T visitMainDescription(JavadocCommentsParser.MainDescriptionContext ctx);
25 /**
26 * Visit a parse tree produced by {@link JavadocCommentsParser#blockTag}.
27 * @param ctx the parse tree
28 * @return the visitor result
29 */
30 T visitBlockTag(JavadocCommentsParser.BlockTagContext ctx);
31 /**
32 * Visit a parse tree produced by {@link JavadocCommentsParser#authorTag}.
33 * @param ctx the parse tree
34 * @return the visitor result
35 */
36 T visitAuthorTag(JavadocCommentsParser.AuthorTagContext ctx);
37 /**
38 * Visit a parse tree produced by {@link JavadocCommentsParser#deprecatedTag}.
39 * @param ctx the parse tree
40 * @return the visitor result
41 */
42 T visitDeprecatedTag(JavadocCommentsParser.DeprecatedTagContext ctx);
43 /**
44 * Visit a parse tree produced by {@link JavadocCommentsParser#returnTag}.
45 * @param ctx the parse tree
46 * @return the visitor result
47 */
48 T visitReturnTag(JavadocCommentsParser.ReturnTagContext ctx);
49 /**
50 * Visit a parse tree produced by {@link JavadocCommentsParser#parameterTag}.
51 * @param ctx the parse tree
52 * @return the visitor result
53 */
54 T visitParameterTag(JavadocCommentsParser.ParameterTagContext ctx);
55 /**
56 * Visit a parse tree produced by {@link JavadocCommentsParser#throwsTag}.
57 * @param ctx the parse tree
58 * @return the visitor result
59 */
60 T visitThrowsTag(JavadocCommentsParser.ThrowsTagContext ctx);
61 /**
62 * Visit a parse tree produced by {@link JavadocCommentsParser#exceptionTag}.
63 * @param ctx the parse tree
64 * @return the visitor result
65 */
66 T visitExceptionTag(JavadocCommentsParser.ExceptionTagContext ctx);
67 /**
68 * Visit a parse tree produced by {@link JavadocCommentsParser#sinceTag}.
69 * @param ctx the parse tree
70 * @return the visitor result
71 */
72 T visitSinceTag(JavadocCommentsParser.SinceTagContext ctx);
73 /**
74 * Visit a parse tree produced by {@link JavadocCommentsParser#versionTag}.
75 * @param ctx the parse tree
76 * @return the visitor result
77 */
78 T visitVersionTag(JavadocCommentsParser.VersionTagContext ctx);
79 /**
80 * Visit a parse tree produced by {@link JavadocCommentsParser#seeTag}.
81 * @param ctx the parse tree
82 * @return the visitor result
83 */
84 T visitSeeTag(JavadocCommentsParser.SeeTagContext ctx);
85 /**
86 * Visit a parse tree produced by {@link JavadocCommentsParser#hiddenTag}.
87 * @param ctx the parse tree
88 * @return the visitor result
89 */
90 T visitHiddenTag(JavadocCommentsParser.HiddenTagContext ctx);
91 /**
92 * Visit a parse tree produced by {@link JavadocCommentsParser#usesTag}.
93 * @param ctx the parse tree
94 * @return the visitor result
95 */
96 T visitUsesTag(JavadocCommentsParser.UsesTagContext ctx);
97 /**
98 * Visit a parse tree produced by {@link JavadocCommentsParser#providesTag}.
99 * @param ctx the parse tree
100 * @return the visitor result
101 */
102 T visitProvidesTag(JavadocCommentsParser.ProvidesTagContext ctx);
103 /**
104 * Visit a parse tree produced by {@link JavadocCommentsParser#serialTag}.
105 * @param ctx the parse tree
106 * @return the visitor result
107 */
108 T visitSerialTag(JavadocCommentsParser.SerialTagContext ctx);
109 /**
110 * Visit a parse tree produced by {@link JavadocCommentsParser#serialDataTag}.
111 * @param ctx the parse tree
112 * @return the visitor result
113 */
114 T visitSerialDataTag(JavadocCommentsParser.SerialDataTagContext ctx);
115 /**
116 * Visit a parse tree produced by {@link JavadocCommentsParser#serialFieldTag}.
117 * @param ctx the parse tree
118 * @return the visitor result
119 */
120 T visitSerialFieldTag(JavadocCommentsParser.SerialFieldTagContext ctx);
121 /**
122 * Visit a parse tree produced by {@link JavadocCommentsParser#customBlockTag}.
123 * @param ctx the parse tree
124 * @return the visitor result
125 */
126 T visitCustomBlockTag(JavadocCommentsParser.CustomBlockTagContext ctx);
127 /**
128 * Visit a parse tree produced by {@link JavadocCommentsParser#inlineTag}.
129 * @param ctx the parse tree
130 * @return the visitor result
131 */
132 T visitInlineTag(JavadocCommentsParser.InlineTagContext ctx);
133 /**
134 * Visit a parse tree produced by {@link JavadocCommentsParser#inlineTagContent}.
135 * @param ctx the parse tree
136 * @return the visitor result
137 */
138 T visitInlineTagContent(JavadocCommentsParser.InlineTagContentContext ctx);
139 /**
140 * Visit a parse tree produced by {@link JavadocCommentsParser#codeInlineTag}.
141 * @param ctx the parse tree
142 * @return the visitor result
143 */
144 T visitCodeInlineTag(JavadocCommentsParser.CodeInlineTagContext ctx);
145 /**
146 * Visit a parse tree produced by {@link JavadocCommentsParser#linkPlainInlineTag}.
147 * @param ctx the parse tree
148 * @return the visitor result
149 */
150 T visitLinkPlainInlineTag(JavadocCommentsParser.LinkPlainInlineTagContext ctx);
151 /**
152 * Visit a parse tree produced by {@link JavadocCommentsParser#linkInlineTag}.
153 * @param ctx the parse tree
154 * @return the visitor result
155 */
156 T visitLinkInlineTag(JavadocCommentsParser.LinkInlineTagContext ctx);
157 /**
158 * Visit a parse tree produced by {@link JavadocCommentsParser#valueInlineTag}.
159 * @param ctx the parse tree
160 * @return the visitor result
161 */
162 T visitValueInlineTag(JavadocCommentsParser.ValueInlineTagContext ctx);
163 /**
164 * Visit a parse tree produced by {@link JavadocCommentsParser#inheritDocInlineTag}.
165 * @param ctx the parse tree
166 * @return the visitor result
167 */
168 T visitInheritDocInlineTag(JavadocCommentsParser.InheritDocInlineTagContext ctx);
169 /**
170 * Visit a parse tree produced by {@link JavadocCommentsParser#summaryInlineTag}.
171 * @param ctx the parse tree
172 * @return the visitor result
173 */
174 T visitSummaryInlineTag(JavadocCommentsParser.SummaryInlineTagContext ctx);
175 /**
176 * Visit a parse tree produced by {@link JavadocCommentsParser#systemPropertyInlineTag}.
177 * @param ctx the parse tree
178 * @return the visitor result
179 */
180 T visitSystemPropertyInlineTag(JavadocCommentsParser.SystemPropertyInlineTagContext ctx);
181 /**
182 * Visit a parse tree produced by {@link JavadocCommentsParser#indexInlineTag}.
183 * @param ctx the parse tree
184 * @return the visitor result
185 */
186 T visitIndexInlineTag(JavadocCommentsParser.IndexInlineTagContext ctx);
187 /**
188 * Visit a parse tree produced by {@link JavadocCommentsParser#returnInlineTag}.
189 * @param ctx the parse tree
190 * @return the visitor result
191 */
192 T visitReturnInlineTag(JavadocCommentsParser.ReturnInlineTagContext ctx);
193 /**
194 * Visit a parse tree produced by {@link JavadocCommentsParser#literalInlineTag}.
195 * @param ctx the parse tree
196 * @return the visitor result
197 */
198 T visitLiteralInlineTag(JavadocCommentsParser.LiteralInlineTagContext ctx);
199 /**
200 * Visit a parse tree produced by {@link JavadocCommentsParser#snippetInlineTag}.
201 * @param ctx the parse tree
202 * @return the visitor result
203 */
204 T visitSnippetInlineTag(JavadocCommentsParser.SnippetInlineTagContext ctx);
205 /**
206 * Visit a parse tree produced by {@link JavadocCommentsParser#customInlineTag}.
207 * @param ctx the parse tree
208 * @return the visitor result
209 */
210 T visitCustomInlineTag(JavadocCommentsParser.CustomInlineTagContext ctx);
211 /**
212 * Visit a parse tree produced by {@link JavadocCommentsParser#reference}.
213 * @param ctx the parse tree
214 * @return the visitor result
215 */
216 T visitReference(JavadocCommentsParser.ReferenceContext ctx);
217 /**
218 * Visit a parse tree produced by {@link JavadocCommentsParser#typeName}.
219 * @param ctx the parse tree
220 * @return the visitor result
221 */
222 T visitTypeName(JavadocCommentsParser.TypeNameContext ctx);
223 /**
224 * Visit a parse tree produced by {@link JavadocCommentsParser#qualifiedName}.
225 * @param ctx the parse tree
226 * @return the visitor result
227 */
228 T visitQualifiedName(JavadocCommentsParser.QualifiedNameContext ctx);
229 /**
230 * Visit a parse tree produced by {@link JavadocCommentsParser#typeArguments}.
231 * @param ctx the parse tree
232 * @return the visitor result
233 */
234 T visitTypeArguments(JavadocCommentsParser.TypeArgumentsContext ctx);
235 /**
236 * Visit a parse tree produced by {@link JavadocCommentsParser#typeArgument}.
237 * @param ctx the parse tree
238 * @return the visitor result
239 */
240 T visitTypeArgument(JavadocCommentsParser.TypeArgumentContext ctx);
241 /**
242 * Visit a parse tree produced by {@link JavadocCommentsParser#memberReference}.
243 * @param ctx the parse tree
244 * @return the visitor result
245 */
246 T visitMemberReference(JavadocCommentsParser.MemberReferenceContext ctx);
247 /**
248 * Visit a parse tree produced by {@link JavadocCommentsParser#parameterTypeList}.
249 * @param ctx the parse tree
250 * @return the visitor result
251 */
252 T visitParameterTypeList(JavadocCommentsParser.ParameterTypeListContext ctx);
253 /**
254 * Visit a parse tree produced by {@link JavadocCommentsParser#snippetAttribute}.
255 * @param ctx the parse tree
256 * @return the visitor result
257 */
258 T visitSnippetAttribute(JavadocCommentsParser.SnippetAttributeContext ctx);
259 /**
260 * Visit a parse tree produced by {@link JavadocCommentsParser#snippetBody}.
261 * @param ctx the parse tree
262 * @return the visitor result
263 */
264 T visitSnippetBody(JavadocCommentsParser.SnippetBodyContext ctx);
265 /**
266 * Visit a parse tree produced by {@link JavadocCommentsParser#description}.
267 * @param ctx the parse tree
268 * @return the visitor result
269 */
270 T visitDescription(JavadocCommentsParser.DescriptionContext ctx);
271 /**
272 * Visit a parse tree produced by {@link JavadocCommentsParser#htmlElement}.
273 * @param ctx the parse tree
274 * @return the visitor result
275 */
276 T visitHtmlElement(JavadocCommentsParser.HtmlElementContext ctx);
277 /**
278 * Visit a parse tree produced by {@link JavadocCommentsParser#voidElement}.
279 * @param ctx the parse tree
280 * @return the visitor result
281 */
282 T visitVoidElement(JavadocCommentsParser.VoidElementContext ctx);
283 /**
284 * Visit a parse tree produced by {@link JavadocCommentsParser#tightElement}.
285 * @param ctx the parse tree
286 * @return the visitor result
287 */
288 T visitTightElement(JavadocCommentsParser.TightElementContext ctx);
289 /**
290 * Visit a parse tree produced by {@link JavadocCommentsParser#nonTightElement}.
291 * @param ctx the parse tree
292 * @return the visitor result
293 */
294 T visitNonTightElement(JavadocCommentsParser.NonTightElementContext ctx);
295 /**
296 * Visit a parse tree produced by {@link JavadocCommentsParser#selfClosingElement}.
297 * @param ctx the parse tree
298 * @return the visitor result
299 */
300 T visitSelfClosingElement(JavadocCommentsParser.SelfClosingElementContext ctx);
301 /**
302 * Visit a parse tree produced by {@link JavadocCommentsParser#htmlTagStart}.
303 * @param ctx the parse tree
304 * @return the visitor result
305 */
306 T visitHtmlTagStart(JavadocCommentsParser.HtmlTagStartContext ctx);
307 /**
308 * Visit a parse tree produced by {@link JavadocCommentsParser#htmlTagEnd}.
309 * @param ctx the parse tree
310 * @return the visitor result
311 */
312 T visitHtmlTagEnd(JavadocCommentsParser.HtmlTagEndContext ctx);
313 /**
314 * Visit a parse tree produced by {@link JavadocCommentsParser#htmlAttribute}.
315 * @param ctx the parse tree
316 * @return the visitor result
317 */
318 T visitHtmlAttribute(JavadocCommentsParser.HtmlAttributeContext ctx);
319 /**
320 * Visit a parse tree produced by {@link JavadocCommentsParser#htmlContent}.
321 * @param ctx the parse tree
322 * @return the visitor result
323 */
324 T visitHtmlContent(JavadocCommentsParser.HtmlContentContext ctx);
325 /**
326 * Visit a parse tree produced by {@link JavadocCommentsParser#nonTightHtmlContent}.
327 * @param ctx the parse tree
328 * @return the visitor result
329 */
330 T visitNonTightHtmlContent(JavadocCommentsParser.NonTightHtmlContentContext ctx);
331 /**
332 * Visit a parse tree produced by {@link JavadocCommentsParser#htmlComment}.
333 * @param ctx the parse tree
334 * @return the visitor result
335 */
336 T visitHtmlComment(JavadocCommentsParser.HtmlCommentContext ctx);
337 /**
338 * Visit a parse tree produced by {@link JavadocCommentsParser#htmlCommentContent}.
339 * @param ctx the parse tree
340 * @return the visitor result
341 */
342 T visitHtmlCommentContent(JavadocCommentsParser.HtmlCommentContentContext ctx);
343 }