001// Generated from JavadocParser.g4 by ANTLR 4.3
002
003package com.puppycrawl.tools.checkstyle.grammars.javadoc;
004
005import org.antlr.v4.runtime.misc.NotNull;
006import org.antlr.v4.runtime.tree.ParseTreeVisitor;
007
008/**
009 * This interface defines a complete generic visitor for a parse tree produced
010 * by {@link JavadocParser}.
011 *
012 * @param <T> The return type of the visit operation. Use {@link Void} for
013 * operations with no return type.
014 */
015public interface JavadocParserVisitor<T> extends ParseTreeVisitor<T> {
016        /**
017         * Visit a parse tree produced by {@link JavadocParser#body}.
018         * @param ctx the parse tree
019         * @return the visitor result
020         */
021        T visitBody(@NotNull JavadocParser.BodyContext ctx);
022
023        /**
024         * Visit a parse tree produced by {@link JavadocParser#liTagOpen}.
025         * @param ctx the parse tree
026         * @return the visitor result
027         */
028        T visitLiTagOpen(@NotNull JavadocParser.LiTagOpenContext ctx);
029
030        /**
031         * Visit a parse tree produced by {@link JavadocParser#paragraph}.
032         * @param ctx the parse tree
033         * @return the visitor result
034         */
035        T visitParagraph(@NotNull JavadocParser.ParagraphContext ctx);
036
037        /**
038         * Visit a parse tree produced by {@link JavadocParser#tr}.
039         * @param ctx the parse tree
040         * @return the visitor result
041         */
042        T visitTr(@NotNull JavadocParser.TrContext ctx);
043
044        /**
045         * Visit a parse tree produced by {@link JavadocParser#colgroup}.
046         * @param ctx the parse tree
047         * @return the visitor result
048         */
049        T visitColgroup(@NotNull JavadocParser.ColgroupContext ctx);
050
051        /**
052         * Visit a parse tree produced by {@link JavadocParser#javadoc}.
053         * @param ctx the parse tree
054         * @return the visitor result
055         */
056        T visitJavadoc(@NotNull JavadocParser.JavadocContext ctx);
057
058        /**
059         * Visit a parse tree produced by {@link JavadocParser#tfootTagClose}.
060         * @param ctx the parse tree
061         * @return the visitor result
062         */
063        T visitTfootTagClose(@NotNull JavadocParser.TfootTagCloseContext ctx);
064
065        /**
066         * Visit a parse tree produced by {@link JavadocParser#td}.
067         * @param ctx the parse tree
068         * @return the visitor result
069         */
070        T visitTd(@NotNull JavadocParser.TdContext ctx);
071
072        /**
073         * Visit a parse tree produced by {@link JavadocParser#linkTag}.
074         * @param ctx the parse tree
075         * @return the visitor result
076         */
077        T visitLinkTag(@NotNull JavadocParser.LinkTagContext ctx);
078
079        /**
080         * Visit a parse tree produced by {@link JavadocParser#thTagOpen}.
081         * @param ctx the parse tree
082         * @return the visitor result
083         */
084        T visitThTagOpen(@NotNull JavadocParser.ThTagOpenContext ctx);
085
086        /**
087         * Visit a parse tree produced by {@link JavadocParser#basefrontTag}.
088         * @param ctx the parse tree
089         * @return the visitor result
090         */
091        T visitBasefrontTag(@NotNull JavadocParser.BasefrontTagContext ctx);
092
093        /**
094         * Visit a parse tree produced by {@link JavadocParser#th}.
095         * @param ctx the parse tree
096         * @return the visitor result
097         */
098        T visitTh(@NotNull JavadocParser.ThContext ctx);
099
100        /**
101         * Visit a parse tree produced by {@link JavadocParser#tdTagClose}.
102         * @param ctx the parse tree
103         * @return the visitor result
104         */
105        T visitTdTagClose(@NotNull JavadocParser.TdTagCloseContext ctx);
106
107        /**
108         * Visit a parse tree produced by {@link JavadocParser#tbodyTagClose}.
109         * @param ctx the parse tree
110         * @return the visitor result
111         */
112        T visitTbodyTagClose(@NotNull JavadocParser.TbodyTagCloseContext ctx);
113
114        /**
115         * Visit a parse tree produced by {@link JavadocParser#description}.
116         * @param ctx the parse tree
117         * @return the visitor result
118         */
119        T visitDescription(@NotNull JavadocParser.DescriptionContext ctx);
120
121        /**
122         * Visit a parse tree produced by {@link JavadocParser#parameters}.
123         * @param ctx the parse tree
124         * @return the visitor result
125         */
126        T visitParameters(@NotNull JavadocParser.ParametersContext ctx);
127
128        /**
129         * Visit a parse tree produced by {@link JavadocParser#metaTag}.
130         * @param ctx the parse tree
131         * @return the visitor result
132         */
133        T visitMetaTag(@NotNull JavadocParser.MetaTagContext ctx);
134
135        /**
136         * Visit a parse tree produced by {@link JavadocParser#head}.
137         * @param ctx the parse tree
138         * @return the visitor result
139         */
140        T visitHead(@NotNull JavadocParser.HeadContext ctx);
141
142        /**
143         * Visit a parse tree produced by {@link JavadocParser#htmlTagOpen}.
144         * @param ctx the parse tree
145         * @return the visitor result
146         */
147        T visitHtmlTagOpen(@NotNull JavadocParser.HtmlTagOpenContext ctx);
148
149        /**
150         * Visit a parse tree produced by {@link JavadocParser#option}.
151         * @param ctx the parse tree
152         * @return the visitor result
153         */
154        T visitOption(@NotNull JavadocParser.OptionContext ctx);
155
156        /**
157         * Visit a parse tree produced by {@link JavadocParser#bodyTagClose}.
158         * @param ctx the parse tree
159         * @return the visitor result
160         */
161        T visitBodyTagClose(@NotNull JavadocParser.BodyTagCloseContext ctx);
162
163        /**
164         * Visit a parse tree produced by {@link JavadocParser#singletonTag}.
165         * @param ctx the parse tree
166         * @return the visitor result
167         */
168        T visitSingletonTag(@NotNull JavadocParser.SingletonTagContext ctx);
169
170        /**
171         * Visit a parse tree produced by {@link JavadocParser#ddTagClose}.
172         * @param ctx the parse tree
173         * @return the visitor result
174         */
175        T visitDdTagClose(@NotNull JavadocParser.DdTagCloseContext ctx);
176
177        /**
178         * Visit a parse tree produced by {@link JavadocParser#text}.
179         * @param ctx the parse tree
180         * @return the visitor result
181         */
182        T visitText(@NotNull JavadocParser.TextContext ctx);
183
184        /**
185         * Visit a parse tree produced by {@link JavadocParser#javadocInlineTag}.
186         * @param ctx the parse tree
187         * @return the visitor result
188         */
189        T visitJavadocInlineTag(@NotNull JavadocParser.JavadocInlineTagContext ctx);
190
191        /**
192         * Visit a parse tree produced by {@link JavadocParser#trTagOpen}.
193         * @param ctx the parse tree
194         * @return the visitor result
195         */
196        T visitTrTagOpen(@NotNull JavadocParser.TrTagOpenContext ctx);
197
198        /**
199         * Visit a parse tree produced by {@link JavadocParser#tfootTagOpen}.
200         * @param ctx the parse tree
201         * @return the visitor result
202         */
203        T visitTfootTagOpen(@NotNull JavadocParser.TfootTagOpenContext ctx);
204
205        /**
206         * Visit a parse tree produced by {@link JavadocParser#isindexTag}.
207         * @param ctx the parse tree
208         * @return the visitor result
209         */
210        T visitIsindexTag(@NotNull JavadocParser.IsindexTagContext ctx);
211
212        /**
213         * Visit a parse tree produced by {@link JavadocParser#theadTagOpen}.
214         * @param ctx the parse tree
215         * @return the visitor result
216         */
217        T visitTheadTagOpen(@NotNull JavadocParser.TheadTagOpenContext ctx);
218
219        /**
220         * Visit a parse tree produced by {@link JavadocParser#tdTagOpen}.
221         * @param ctx the parse tree
222         * @return the visitor result
223         */
224        T visitTdTagOpen(@NotNull JavadocParser.TdTagOpenContext ctx);
225
226        /**
227         * Visit a parse tree produced by {@link JavadocParser#pTagClose}.
228         * @param ctx the parse tree
229         * @return the visitor result
230         */
231        T visitPTagClose(@NotNull JavadocParser.PTagCloseContext ctx);
232
233        /**
234         * Visit a parse tree produced by {@link JavadocParser#optionTagOpen}.
235         * @param ctx the parse tree
236         * @return the visitor result
237         */
238        T visitOptionTagOpen(@NotNull JavadocParser.OptionTagOpenContext ctx);
239
240        /**
241         * Visit a parse tree produced by {@link JavadocParser#tfoot}.
242         * @param ctx the parse tree
243         * @return the visitor result
244         */
245        T visitTfoot(@NotNull JavadocParser.TfootContext ctx);
246
247        /**
248         * Visit a parse tree produced by {@link JavadocParser#li}.
249         * @param ctx the parse tree
250         * @return the visitor result
251         */
252        T visitLi(@NotNull JavadocParser.LiContext ctx);
253
254        /**
255         * Visit a parse tree produced by {@link JavadocParser#htmlElement}.
256         * @param ctx the parse tree
257         * @return the visitor result
258         */
259        T visitHtmlElement(@NotNull JavadocParser.HtmlElementContext ctx);
260
261        /**
262         * Visit a parse tree produced by {@link JavadocParser#htmlComment}.
263         * @param ctx the parse tree
264         * @return the visitor result
265         */
266        T visitHtmlComment(@NotNull JavadocParser.HtmlCommentContext ctx);
267
268        /**
269         * Visit a parse tree produced by {@link JavadocParser#dtTagOpen}.
270         * @param ctx the parse tree
271         * @return the visitor result
272         */
273        T visitDtTagOpen(@NotNull JavadocParser.DtTagOpenContext ctx);
274
275        /**
276         * Visit a parse tree produced by {@link JavadocParser#liTagClose}.
277         * @param ctx the parse tree
278         * @return the visitor result
279         */
280        T visitLiTagClose(@NotNull JavadocParser.LiTagCloseContext ctx);
281
282        /**
283         * Visit a parse tree produced by {@link JavadocParser#areaTag}.
284         * @param ctx the parse tree
285         * @return the visitor result
286         */
287        T visitAreaTag(@NotNull JavadocParser.AreaTagContext ctx);
288
289        /**
290         * Visit a parse tree produced by {@link JavadocParser#pTagOpen}.
291         * @param ctx the parse tree
292         * @return the visitor result
293         */
294        T visitPTagOpen(@NotNull JavadocParser.PTagOpenContext ctx);
295
296        /**
297         * Visit a parse tree produced by {@link JavadocParser#inputTag}.
298         * @param ctx the parse tree
299         * @return the visitor result
300         */
301        T visitInputTag(@NotNull JavadocParser.InputTagContext ctx);
302
303        /**
304         * Visit a parse tree produced by {@link JavadocParser#tbodyTagOpen}.
305         * @param ctx the parse tree
306         * @return the visitor result
307         */
308        T visitTbodyTagOpen(@NotNull JavadocParser.TbodyTagOpenContext ctx);
309
310        /**
311         * Visit a parse tree produced by {@link JavadocParser#javadocTag}.
312         * @param ctx the parse tree
313         * @return the visitor result
314         */
315        T visitJavadocTag(@NotNull JavadocParser.JavadocTagContext ctx);
316
317        /**
318         * Visit a parse tree produced by {@link JavadocParser#htmlTagClose}.
319         * @param ctx the parse tree
320         * @return the visitor result
321         */
322        T visitHtmlTagClose(@NotNull JavadocParser.HtmlTagCloseContext ctx);
323
324        /**
325         * Visit a parse tree produced by {@link JavadocParser#dt}.
326         * @param ctx the parse tree
327         * @return the visitor result
328         */
329        T visitDt(@NotNull JavadocParser.DtContext ctx);
330
331        /**
332         * Visit a parse tree produced by {@link JavadocParser#headTagOpen}.
333         * @param ctx the parse tree
334         * @return the visitor result
335         */
336        T visitHeadTagOpen(@NotNull JavadocParser.HeadTagOpenContext ctx);
337
338        /**
339         * Visit a parse tree produced by {@link JavadocParser#headTagClose}.
340         * @param ctx the parse tree
341         * @return the visitor result
342         */
343        T visitHeadTagClose(@NotNull JavadocParser.HeadTagCloseContext ctx);
344
345        /**
346         * Visit a parse tree produced by {@link JavadocParser#thTagClose}.
347         * @param ctx the parse tree
348         * @return the visitor result
349         */
350        T visitThTagClose(@NotNull JavadocParser.ThTagCloseContext ctx);
351
352        /**
353         * Visit a parse tree produced by {@link JavadocParser#ddTagOpen}.
354         * @param ctx the parse tree
355         * @return the visitor result
356         */
357        T visitDdTagOpen(@NotNull JavadocParser.DdTagOpenContext ctx);
358
359        /**
360         * Visit a parse tree produced by {@link JavadocParser#optionTagClose}.
361         * @param ctx the parse tree
362         * @return the visitor result
363         */
364        T visitOptionTagClose(@NotNull JavadocParser.OptionTagCloseContext ctx);
365
366        /**
367         * Visit a parse tree produced by {@link JavadocParser#attribute}.
368         * @param ctx the parse tree
369         * @return the visitor result
370         */
371        T visitAttribute(@NotNull JavadocParser.AttributeContext ctx);
372
373        /**
374         * Visit a parse tree produced by {@link JavadocParser#dd}.
375         * @param ctx the parse tree
376         * @return the visitor result
377         */
378        T visitDd(@NotNull JavadocParser.DdContext ctx);
379
380        /**
381         * Visit a parse tree produced by {@link JavadocParser#trTagClose}.
382         * @param ctx the parse tree
383         * @return the visitor result
384         */
385        T visitTrTagClose(@NotNull JavadocParser.TrTagCloseContext ctx);
386
387        /**
388         * Visit a parse tree produced by {@link JavadocParser#singletonTagName}.
389         * @param ctx the parse tree
390         * @return the visitor result
391         */
392        T visitSingletonTagName(@NotNull JavadocParser.SingletonTagNameContext ctx);
393
394        /**
395         * Visit a parse tree produced by {@link JavadocParser#dtTagClose}.
396         * @param ctx the parse tree
397         * @return the visitor result
398         */
399        T visitDtTagClose(@NotNull JavadocParser.DtTagCloseContext ctx);
400
401        /**
402         * Visit a parse tree produced by {@link JavadocParser#htmlElementOpen}.
403         * @param ctx the parse tree
404         * @return the visitor result
405         */
406        T visitHtmlElementOpen(@NotNull JavadocParser.HtmlElementOpenContext ctx);
407
408        /**
409         * Visit a parse tree produced by {@link JavadocParser#brTag}.
410         * @param ctx the parse tree
411         * @return the visitor result
412         */
413        T visitBrTag(@NotNull JavadocParser.BrTagContext ctx);
414
415        /**
416         * Visit a parse tree produced by {@link JavadocParser#thead}.
417         * @param ctx the parse tree
418         * @return the visitor result
419         */
420        T visitThead(@NotNull JavadocParser.TheadContext ctx);
421
422        /**
423         * Visit a parse tree produced by {@link JavadocParser#paramTag}.
424         * @param ctx the parse tree
425         * @return the visitor result
426         */
427        T visitParamTag(@NotNull JavadocParser.ParamTagContext ctx);
428
429        /**
430         * Visit a parse tree produced by {@link JavadocParser#singletonElement}.
431         * @param ctx the parse tree
432         * @return the visitor result
433         */
434        T visitSingletonElement(@NotNull JavadocParser.SingletonElementContext ctx);
435
436        /**
437         * Visit a parse tree produced by {@link JavadocParser#theadTagClose}.
438         * @param ctx the parse tree
439         * @return the visitor result
440         */
441        T visitTheadTagClose(@NotNull JavadocParser.TheadTagCloseContext ctx);
442
443        /**
444         * Visit a parse tree produced by {@link JavadocParser#htmlElementClose}.
445         * @param ctx the parse tree
446         * @return the visitor result
447         */
448        T visitHtmlElementClose(@NotNull JavadocParser.HtmlElementCloseContext ctx);
449
450        /**
451         * Visit a parse tree produced by {@link JavadocParser#wrongSinletonTag}.
452         * @param ctx the parse tree
453         * @return the visitor result
454         */
455        T visitWrongSinletonTag(@NotNull JavadocParser.WrongSinletonTagContext ctx);
456
457        /**
458         * Visit a parse tree produced by {@link JavadocParser#bodyTagOpen}.
459         * @param ctx the parse tree
460         * @return the visitor result
461         */
462        T visitBodyTagOpen(@NotNull JavadocParser.BodyTagOpenContext ctx);
463
464        /**
465         * Visit a parse tree produced by {@link JavadocParser#htmlTag}.
466         * @param ctx the parse tree
467         * @return the visitor result
468         */
469        T visitHtmlTag(@NotNull JavadocParser.HtmlTagContext ctx);
470
471        /**
472         * Visit a parse tree produced by {@link JavadocParser#baseTag}.
473         * @param ctx the parse tree
474         * @return the visitor result
475         */
476        T visitBaseTag(@NotNull JavadocParser.BaseTagContext ctx);
477
478        /**
479         * Visit a parse tree produced by {@link JavadocParser#reference}.
480         * @param ctx the parse tree
481         * @return the visitor result
482         */
483        T visitReference(@NotNull JavadocParser.ReferenceContext ctx);
484
485        /**
486         * Visit a parse tree produced by {@link JavadocParser#imgTag}.
487         * @param ctx the parse tree
488         * @return the visitor result
489         */
490        T visitImgTag(@NotNull JavadocParser.ImgTagContext ctx);
491
492        /**
493         * Visit a parse tree produced by {@link JavadocParser#frameTag}.
494         * @param ctx the parse tree
495         * @return the visitor result
496         */
497        T visitFrameTag(@NotNull JavadocParser.FrameTagContext ctx);
498
499        /**
500         * Visit a parse tree produced by {@link JavadocParser#colgroupTagClose}.
501         * @param ctx the parse tree
502         * @return the visitor result
503         */
504        T visitColgroupTagClose(@NotNull JavadocParser.ColgroupTagCloseContext ctx);
505
506        /**
507         * Visit a parse tree produced by {@link JavadocParser#colgroupTagOpen}.
508         * @param ctx the parse tree
509         * @return the visitor result
510         */
511        T visitColgroupTagOpen(@NotNull JavadocParser.ColgroupTagOpenContext ctx);
512
513        /**
514         * Visit a parse tree produced by {@link JavadocParser#tbody}.
515         * @param ctx the parse tree
516         * @return the visitor result
517         */
518        T visitTbody(@NotNull JavadocParser.TbodyContext ctx);
519
520        /**
521         * Visit a parse tree produced by {@link JavadocParser#html}.
522         * @param ctx the parse tree
523         * @return the visitor result
524         */
525        T visitHtml(@NotNull JavadocParser.HtmlContext ctx);
526
527        /**
528         * Visit a parse tree produced by {@link JavadocParser#colTag}.
529         * @param ctx the parse tree
530         * @return the visitor result
531         */
532        T visitColTag(@NotNull JavadocParser.ColTagContext ctx);
533
534        /**
535         * Visit a parse tree produced by {@link JavadocParser#hrTag}.
536         * @param ctx the parse tree
537         * @return the visitor result
538         */
539        T visitHrTag(@NotNull JavadocParser.HrTagContext ctx);
540}