1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2016 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*/
package com.github.javaparser;
import com.github.javaparser.javadoc.Javadoc;
import com.github.javaparser.javadoc.JavadocBlockTag;
import com.github.javaparser.javadoc.description.JavadocDescription;
import org.junit.Assert;
import org.junit.Test;
import static com.github.javaparser.utils.Utils.EOL;
import static org.junit.Assert.assertEquals;
public class JavadocParserTest {
@Test
public void parseSimplestContent() {
Assert.assertEquals(new Javadoc(JavadocDescription.parseText("A simple line of text")),
JavadocParser.parse("A simple line of text"));
}
@Test
public void parseSingleLineWithSpacing() {
assertEquals(new Javadoc(JavadocDescription.parseText("The line number of the first character of this Token.")),
JavadocParser.parse(" The line number of the first character of this Token. "));
}
@Test
public void parseSingleLineWithNewLines() {
assertEquals(new Javadoc(JavadocDescription.parseText("The string image of the token.")),
JavadocParser.parse(EOL +
" * The string image of the token." + EOL +
" "));
}
@Test
public void parseCommentWithNewLines() {
String text = EOL +
" * The version identifier for this Serializable class." + EOL +
" * Increment only if the <i>serialized</i> form of the" + EOL +
" * class changes." + EOL +
" ";
assertEquals(new Javadoc(JavadocDescription.parseText("The version identifier for this Serializable class." + EOL +
"Increment only if the <i>serialized</i> form of the" + EOL +
"class changes.")),
JavadocParser.parse(text));
}
@Test
public void parseCommentWithIndentation() {
String text = "Returns a new Token object, by default." + EOL +
" * However, if you want, you can create and return subclass objects based on the value of ofKind." + EOL +
" *" + EOL +
" * case MyParserConstants.ID : return new IDToken(ofKind, image);" + EOL +
" *" + EOL +
" * to the following switch statement. Then you can cast matchedToken";
assertEquals(new Javadoc(JavadocDescription.parseText("Returns a new Token object, by default." + EOL +
"However, if you want, you can create and return subclass objects based on the value of ofKind." + EOL +
EOL +
" case MyParserConstants.ID : return new IDToken(ofKind, image);" + EOL +
EOL +
"to the following switch statement. Then you can cast matchedToken")),
JavadocParser.parse(text));
}
@Test
public void parseBlockTagsAndEmptyDescription() {
String text = EOL +
" * @deprecated" + EOL +
" * @see #getEndColumn" + EOL +
" ";
assertEquals(new Javadoc(JavadocDescription.parseText(""))
.addBlockTag(new JavadocBlockTag(JavadocBlockTag.Type.DEPRECATED, ""))
.addBlockTag(new JavadocBlockTag(JavadocBlockTag.Type.SEE, "#getEndColumn")), JavadocParser.parse(text));
}
@Test
public void parseBlockTagsAndProvideTagName() {
String expectedText = EOL +
" * @unofficial" + EOL + " " +
" ";
Javadoc underTest = new Javadoc(JavadocDescription.parseText(""))
.addBlockTag(new JavadocBlockTag("unofficial", ""));
assertEquals(underTest, JavadocParser.parse(expectedText));
assertEquals(1, underTest.getBlockTags().size());
assertEquals("unofficial", underTest.getBlockTags().get(0).getTagName());
}
@Test
public void parseParamBlockTags() {
String text = EOL +
" * Add a field to this and automatically add the import of the type if needed" + EOL +
" *" + EOL +
" * @param typeClass the type of the field" + EOL +
" * @param name the name of the field" + EOL +
" * @param modifiers the modifiers like {@link Modifier#PUBLIC}" + EOL +
" * @return the {@link FieldDeclaration} created" + EOL +
" ";
Javadoc res = JavadocParser.parse(text);
assertEquals(new Javadoc(JavadocDescription.parseText("Add a field to this and automatically add the import of the type if needed"))
.addBlockTag(JavadocBlockTag.createParamBlockTag("typeClass", "the type of the field"))
.addBlockTag(JavadocBlockTag.createParamBlockTag("name", "the name of the field"))
.addBlockTag(JavadocBlockTag.createParamBlockTag("modifiers", "the modifiers like {@link Modifier#PUBLIC}"))
.addBlockTag(new JavadocBlockTag(JavadocBlockTag.Type.RETURN, "the {@link FieldDeclaration} created")), res);
}
@Test
public void parseMultilineParamBlockTags() {
String text = EOL +
" * Add a field to this and automatically add the import of the type if needed" + EOL +
" *" + EOL +
" * @param typeClass the type of the field" + EOL +
" * continued in a second line" + EOL +
" * @param name the name of the field" + EOL +
" * @param modifiers the modifiers like {@link Modifier#PUBLIC}" + EOL +
" * @return the {@link FieldDeclaration} created" + EOL +
" ";
Javadoc res = JavadocParser.parse(text);
assertEquals(new Javadoc(JavadocDescription.parseText("Add a field to this and automatically add the import of the type if needed"))
.addBlockTag(JavadocBlockTag.createParamBlockTag("typeClass", "the type of the field" + EOL + " continued in a second line"))
.addBlockTag(JavadocBlockTag.createParamBlockTag("name", "the name of the field"))
.addBlockTag(JavadocBlockTag.createParamBlockTag("modifiers", "the modifiers like {@link Modifier#PUBLIC}"))
.addBlockTag(new JavadocBlockTag(JavadocBlockTag.Type.RETURN, "the {@link FieldDeclaration} created")), res);
}
@Test
public void startsWithAsteriskEmpty() {
assertEquals(-1, JavadocParser.startsWithAsterisk(""));
}
@Test
public void startsWithAsteriskNoAsterisk() {
assertEquals(-1, JavadocParser.startsWithAsterisk(" ciao"));
}
@Test
public void startsWithAsteriskAtTheBeginning() {
assertEquals(0, JavadocParser.startsWithAsterisk("* ciao"));
}
@Test
public void startsWithAsteriskAfterSpaces() {
assertEquals(3, JavadocParser.startsWithAsterisk(" * ciao"));
}
}
|
