Skip to content

Commit e2d092f

Browse files
committed
fix some javadoc issues to be able to release
Signed-off-by: olivier lamy <[email protected]>
1 parent 5be15fe commit e2d092f

File tree

3 files changed

+162
-94
lines changed

3 files changed

+162
-94
lines changed

plexus-compilers/plexus-compiler-aspectj/src/main/java/org/codehaus/plexus/compiler/ajc/AspectJCompiler.java

Lines changed: 150 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -28,117 +28,159 @@
2828
import java.util.Map;
2929

3030
/**
31-
* <p/>
31+
* <p>
3232
* Options
33-
* <p/>
33+
* </p>
34+
* <p>
3435
* -injars JarList
35-
* <p/>
36+
* </p>
37+
* <p>
3638
* Accept as source bytecode any .class files inside the specified .jar files. The output will include these
3739
* classes, possibly as woven with any applicable aspects. JarList, like classpath, is a single argument
3840
* containing a list of paths to jar files, delimited by the platform- specific classpath delimiter.
39-
* <p/>
41+
* </p>
42+
* <p>
4043
* -aspectpath JarList
41-
* <p/>
44+
* </p>
45+
* <p>
4246
* Weave binary aspects from JarList zip files into all sources. The aspects should have been output by
4347
* the same version of the compiler. To run the output classes requires putting all the aspectpath entries on
4448
* the run classpath. JarList, like classpath, is a single argument containing a list of paths to jar files,
4549
* delimited by the platform- specific classpath delimiter.
46-
* <p/>
50+
* </p>
51+
* <p>
4752
* -argfile File
48-
* <p/>
53+
* </p>
54+
* <p>
4955
* The file is a line-delimited list of arguments. These arguments are inserted into the argument list.
50-
* <p/>
56+
* </p>
57+
* <p>
5158
* -outjar output.jar
52-
* <p/>
59+
* </p>
60+
* <p>
5361
* Put output classes in zip file output.jar.
54-
* <p/>
62+
* </p>
63+
* <p>
5564
* -incremental
56-
* <p/>
65+
* </p>
66+
* <p>
5767
* Run the compiler continuously. After the initial compilation, the compiler will wait to recompile until it
5868
* reads a newline from the standard input, and will quit when it reads a 'q'. It will only recompile necessary
5969
* components, so a recompile should be much faster than doing a second compile. This requires -sourceroots.
60-
* <p/>
70+
* </p>
71+
* <p>
6172
* -sourceroots DirPaths
62-
* <p/>
73+
* </p>
74+
* <p>
6375
* Find and build all .java or .aj source files under any directory listed in DirPaths. DirPaths, like
6476
* classpath, is a single argument containing a list of paths to directories, delimited by the platform-
6577
* specific classpath delimiter. Required by -incremental.
66-
* <p/>
78+
* </p>
79+
* <p>
6780
* -emacssym
68-
* <p/>
81+
* </p>
82+
* <p>
6983
* Generate .ajesym symbol files for emacs support
70-
* <p/>
84+
* </p>
85+
* <p>
7186
* -Xlint
72-
* <p/>
87+
* </p>
88+
* <p>
7389
* Same as -Xlint:warning (enabled by default)
74-
* <p/>
90+
* </p>
91+
* <p>
7592
* -Xlint:{level}
76-
* <p/>
93+
* </p>
94+
* <p>
7795
* Set default level for messages about potential programming mistakes in crosscutting code. {level} may be
7896
* ignore, warning, or error. This overrides entries in org/aspectj/weaver/XlintDefault.properties from
7997
* aspectjtools.jar, but does not override levels set using the -Xlintfile option.
80-
* <p/>
98+
* </p>
99+
* <p>
81100
* -Xlintfile PropertyFile
82-
* <p/>
101+
* </p>
102+
* <p>
83103
* Specify properties file to set levels for specific crosscutting messages. PropertyFile is a path to a
84104
* Java .properties file that takes the same property names and values as
85105
* org/aspectj/weaver/XlintDefault.properties from aspectjtools.jar, which it also overrides.
86106
* -help
87-
* <p/>
107+
* </p>
108+
* <p>
88109
* Emit information on compiler options and usage
89-
* <p/>
110+
* </p>
111+
* <p>
90112
* -version
91-
* <p/>
113+
* </p>
114+
* <p>
92115
* Emit the version of the AspectJ compiler
93-
* <p/>
116+
* </p>
117+
* <p>
94118
* -classpath Path
95-
* <p/>
119+
* </p>
120+
* <p>
96121
* Specify where to find user class files. Path is a single argument containing a list of paths to zip files
97122
* or directories, delimited by the platform-specific path delimiter.
98-
* <p/>
123+
* </p>
124+
* <p>
99125
* -bootclasspath Path
100-
* <p/>
126+
* </p>
127+
* <p>
101128
* Override location of VM's bootclasspath for purposes of evaluating types when compiling. Path is a single
102129
* argument containing a list of paths to zip files or directories, delimited by the platform-specific path
103130
* delimiter.
104-
* <p/>
131+
* </p>
132+
* <p>
105133
* -extdirs Path
106-
* <p/>
134+
* </p>
135+
* <p>
107136
* Override location of VM's extension directories for purposes of evaluating types when compiling. Path is
108137
* a single argument containing a list of paths to directories, delimited by the platform-specific path
109138
* delimiter.
110-
* <p/>
139+
* </p>
140+
* <p>
111141
* -d Directory
112-
* <p/>
142+
* </p>
143+
* <p>
113144
* Specify where to place generated .class files. If not specified, Directory defaults to the current
114145
* working dir.
115-
* <p/>
146+
* </p>
147+
* <p>
116148
* -target [1.1|1.2]
117-
* <p/>
149+
* </p>
150+
* <p>
118151
* Specify classfile target setting (1.1 or 1.2, default is 1.1)
119-
* <p/>
152+
* </p>
153+
* <p>
120154
* -1.3
121-
* <p/>
155+
* </p>
156+
* <p>
122157
* Set compliance level to 1.3 (default)
123158
* -1.4
124-
* <p/>
159+
* </p>
160+
* <p>
125161
* Set compliance level to 1.4
126162
* -source [1.3|1.4]
127-
* <p/>
163+
* </p>
164+
* <p>
128165
* Toggle assertions (1.3 or 1.4, default is 1.3 in -1.3 mode and 1.4 in -1.4 mode). When using -source 1.3,
129166
* an assert() statement valid under Java 1.4 will result in a compiler error. When using -source 1.4, treat
130167
* assert as a keyword and implement assertions according to the 1.4 language spec.
131-
* <p/>
168+
* </p>
169+
* <p>
132170
* -nowarn
133-
* <p/>
171+
* </p>
172+
* <p>
134173
* Emit no warnings (equivalent to '-warn:none') This does not suppress messages generated by declare warning
135174
* or Xlint.
136-
* <p/>
175+
* </p>
176+
* <p>
137177
* -warn: items
138-
* <p/>
178+
* </p>
179+
* <p>
139180
* Emit warnings for any instances of the comma-delimited list of questionable code
140181
* (eg '-warn:unusedLocals,deprecation'):
141-
* <p/>
182+
* </p>
183+
* <p>
142184
* constructorName method with constructor name
143185
* packageDefaultMethod attempt to override package-default method
144186
* deprecation usage of deprecated type or member
@@ -147,78 +189,96 @@
147189
* unusedArguments method argument never read
148190
* unusedImports import statement not used by code in file
149191
* none suppress all compiler warnings
150-
* <p/>
151-
* <p/>
192+
* </p>
193+
* <p>
152194
* -warn:none does not suppress messages generated by declare warning or Xlint.
153-
* <p/>
195+
* </p>
196+
* <p>
154197
* -deprecation
155-
* <p/>
198+
* </p>
199+
* <p>
156200
* Same as -warn:deprecation
157-
* <p/>
201+
* </p>
202+
* <p>
158203
* -noImportError
159-
* <p/>
204+
* </p>
205+
* <p>
160206
* Emit no errors for unresolved imports
161-
* <p/>
207+
* </p>
208+
* <p>
162209
* -proceedOnError
163-
* <p/>
210+
* </p>
211+
* <p>
164212
* Keep compiling after error, dumping class files with problem methods
165-
* <p/>
213+
* </p>
214+
* <p>
166215
* -g:[lines,vars,source]
167-
* <p/>
216+
* </p>
217+
* <p>
168218
* debug attributes level, that may take three forms:
169-
* <p/>
219+
* </p>
220+
* <p>
170221
* -g all debug info ('-g:lines,vars,source')
171222
* -g:none no debug info
172223
* -g:{items} debug info for any/all of [lines, vars, source], e.g.,
173224
* -g:lines,source
174-
* <p/>
175-
* <p/>
225+
* </p>
226+
* <p>
176227
* -preserveAllLocals
177-
* <p/>
228+
* </p>
229+
* <p>
178230
* Preserve all local variables during code generation (to facilitate debugging).
179-
* <p/>
231+
* </p>
232+
* <p>
180233
* -referenceInfo
181-
* <p/>
234+
* </p>
235+
* <p>
182236
* Compute reference information.
183-
* <p/>
237+
* </p>
238+
* <p>
184239
* -encoding format
185-
* <p/>
240+
* </p>
241+
* <p>
186242
* Specify default source encoding format. Specify custom encoding on a per file basis by suffixing each
187243
* input source file/folder name with '[encoding]'.
188-
* <p/>
244+
* </p>
245+
* <p>
189246
* -verbose
190-
* <p/>
247+
* </p>
248+
* <p>
191249
* Emit messages about accessed/processed compilation units
192-
* <p/>
193-
* -log file
194-
* <p/>
195-
* Specify a log file for compiler messages.
196-
* -progress
197-
* <p/>
198-
* Show progress (requires -log mode).
199-
* -time
200-
* <p/>
201-
* Display speed information.
202-
* -noExit
203-
* <p/>
204-
* Do not call System.exit(n) at end of compilation (n=0 if no error)
205-
* -repeat N
206-
* <p/>
207-
* Repeat compilation process N times (typically to do performance analysis).
208-
* -Xnoweave
209-
* <p/>
210-
* (Experimental) produce unwoven class files for input using -injars.
211-
* -Xnoinline
212-
* <p/>
213-
* (Experimental) do not inline around advice
250+
* </p>
251+
* <p>
252+
* -log file Specify a log file for compiler messages.
253+
* </p>
254+
* <p>
255+
* -progress Show progress (requires -log mode).
256+
* </p>
257+
* <p>
258+
* -time Display speed information.
259+
* </p>
260+
* <p>
261+
* -noExit Do not call System.exit(n) at end of compilation (n=0 if no error)
262+
* </p>
263+
* <p>
264+
* -repeat N Repeat compilation process N times (typically to do performance analysis).
265+
* </p>
266+
* <p>
267+
* -Xnoweave (Experimental) produce unwoven class files for input using -injars.
268+
* </p>
269+
* <p>
270+
* -Xnoinline (Experimental) do not inline around advice
271+
* </p>
272+
* <p>
214273
* -XincrementalFile file
215-
* <p/>
274+
* </p>
275+
* <p>
216276
* (Experimental) This works like incremental mode, but using a file rather than standard input to control
217277
* the compiler. It will recompile each time file is changed and and halt when file is deleted.
218-
* <p/>
219-
* -XserializableAspects
220-
* <p/>
221-
* (Experimental) Normally it is an error to declare aspects Serializable. This option removes that restriction.
278+
* </p>
279+
* <p>
280+
* -XserializableAspects (Experimental) Normally it is an error to declare aspects Serializable. This option removes that restriction.
281+
* </p>
222282
*
223283
* @author <a href="mailto:[email protected]">Jason van Zyl</a>
224284
* @plexus.component role="org.codehaus.plexus.compiler.Compiler" role-hint="aspectj"

plexus-compilers/plexus-compiler-csharp/src/main/java/org/codehaus/plexus/compiler/csharp/DefaultCSharpCompilerParser.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55

66
/**
77
* Handles output from both mono with only the line number
8-
* <p/>
8+
* <p>
99
* ex error = "/home/trygvis/dev/com.myrealbox/trunk/mcs/nunit20/core/./TestRunnerThread.cs(29) error CS0246: Cannot find type 'NameValueCollection'"
10-
* <p/>
11-
* and errors from mono & csc on windows which has column num also
12-
* <p/>
10+
* </p>
11+
* <p>
12+
* and errors from mono &amp; csc on windows which has column num also
13+
* </p>
1314
* ex error = "src\\test\\csharp\\Hierarchy\\Logger.cs(98,4): warning CS0618: 'NUnit.Framework.Assertion' is obsolete: 'Use Assert class instead'";
1415
*
1516
* @author <a href="mailto:[email protected]">Gilles Dodinet</a>

pom.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,13 @@
104104
<artifactId>maven-javadoc-plugin</artifactId>
105105
<configuration>
106106
<additionalparam>-Xdoclint:none</additionalparam>
107+
<tagletArtifacts>
108+
<tagletArtifact combine.id="org.codehaus.plexus:plexus-javadoc">
109+
<groupId>org.codehaus.plexus</groupId>
110+
<artifactId>plexus-javadoc</artifactId>
111+
<version>1.0</version>
112+
</tagletArtifact>
113+
</tagletArtifacts>
107114
</configuration>
108115
</plugin>
109116
</plugins>

0 commit comments

Comments
 (0)