Skip to content

Commit 88d241c

Browse files
hboutemyhboutemy
authored
reformat descriptor description to match usual Modello-generated ones (#316)
1 parent 43b5097 commit 88d241c

File tree

1 file changed

+77
-71
lines changed

1 file changed

+77
-71
lines changed

‎src/site/xdoc/index.xml.vm‎

Lines changed: 77 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -72,43 +72,47 @@
7272

7373
<a name="class_archive"/>
7474
<subsection name="archive">
75+
<p>The <code>&lt;archive&gt;</code> element is the root of the archiver configuration.
76+
The following table lists all of the possible child elements.</p>
7577
<table>
7678
<tr>
7779
<th>Element</th>
78-
<th>Description</th>
7980
<th>Type</th>
8081
<th>Since</th>
82+
<th>Description</th>
8183
</tr>
8284
<tr>
83-
<td>addMavenDescriptor</td>
85+
<td><code>addMavenDescriptor</code></td>
86+
<td><code>boolean</code></td>
87+
<td></td>
8488
<td>
8589
Whether the created archive will contain these two Maven files:
8690
<ul>
8791
<li>
88-
The pom file, located in the archive in
92+
The <code>pom.xml</code> file, located in the archive in
8993
<code>META-INF/maven/${groupId}/${artifactId}/pom.xml</code>
9094
</li>
9195
<li>
92-
A <a href="#pom-properties-content">pom.properties</a> file,
96+
A <code><a href="#pom-properties-content">pom.properties</a></code> file,
9397
located in the archive in <code>META-INF/maven/${groupId}/${artifactId}/pom.properties</code>
9498
</li>
9599
</ul>
96100
The default value is <code>true</code>.
97101
</td>
98-
<td>boolean</td>
99-
<td></td>
100102
</tr>
101103
<tr>
102-
<td>compress</td>
104+
<td><code>compress</code></td>
105+
<td><code>boolean</code></td>
106+
<td></td>
103107
<td>
104108
Activate compression for the archive.
105109
The default value is <code>true</code>.
106110
</td>
107-
<td>boolean</td>
108-
<td></td>
109111
</tr>
110112
<tr>
111-
<td>forced</td>
113+
<td><code>forced</code></td>
114+
<td><code>boolean</code></td>
115+
<td>2.2</td>
112116
<td>
113117
Whether recreating the archive is forced (default) or not. Setting
114118
this option to <code>false</code>, means that the archiver should compare the
@@ -125,11 +129,11 @@
125129
</p>
126130
The default value is <code>true</code>.
127131
</td>
128-
<td>boolean</td>
129-
<td>2.2</td>
130132
</tr>
131133
<tr>
132-
<td>index</td>
134+
<td><code>index</code></td>
135+
<td><code>boolean</code></td>
136+
<td></td>
133137
<td>
134138
<strong>Deprecated:</strong> See <a href="https://bugs.openjdk.org/browse/JDK-8305597">JDK-8305597</a>
135139
<p>
@@ -140,39 +144,37 @@
140144
The default value is <code>false</code>.
141145
</p>
142146
</td>
143-
<td>boolean</td>
144-
<td></td>
145147
</tr>
146148
<tr>
147-
<td>pomPropertiesFile</td>
149+
<td><code>pomPropertiesFile</code></td>
150+
<td><code>File</code></td>
151+
<td>2.3</td>
148152
<td>
149153
Use this to override the auto created
150154
<a href="#pom-properties-content">pom.properties</a> file
151155
(only if <code>addMavenDescriptor</code> is set to <code>true</code>)
152156
</td>
153-
<td>File</td>
154-
<td>2.3</td>
155157
</tr>
156158
<tr>
157-
<td>manifestFile</td>
158-
<td>With this you can supply your own manifest file.</td>
159-
<td>File</td>
159+
<td><code>manifestFile</code></td>
160+
<td><code>File</code></td>
160161
<td></td>
162+
<td>With this you can supply your own manifest file.</td>
161163
</tr>
162164
<tr>
163-
<td><a href="#class_manifest">manifest</a></td>
165+
<td><code><a href="#class_manifest">manifest</a></code></td>
164166
<td></td>
165167
<td></td>
166168
<td></td>
167169
</tr>
168170
<tr>
169-
<td>manifestEntries</td>
170-
<td>A list of key/value pairs to add to the manifest.</td>
171-
<td>Map</td>
171+
<td><code>manifestEntries</code></td>
172+
<td><code>Map</code></td>
172173
<td></td>
174+
<td>A list of key/value pairs to add to the manifest.</td>
173175
</tr>
174176
<tr>
175-
<td><a href="#class_manifestSection">manifestSections</a></td>
177+
<td><code><a href="#class_manifestSection">manifestSections</a></code></td>
176178
<td></td>
177179
<td></td>
178180
<td></td>
@@ -183,7 +185,7 @@
183185
<a name="pom-properties-content"/>
184186
<subsection name="pom.properties content">
185187
<p>
186-
The auto created <code>pom.properties</code> file will contain the
188+
The auto created <code>META-INF/maven/${groupId}/${artifactId}/pom.properties</code> file will contain the
187189
following content:
188190
</p>
189191
<source>
@@ -194,24 +196,28 @@ version=\${project.version}</source>
194196

195197
<a name="class_manifest"/>
196198
<subsection name="manifest">
199+
<p>The <code>&lt;manifest&gt;</code> element configures main section of <code>META-INF/MANIFEST.MF</code>.
200+
The following table lists all of the possible child elements.</p>
197201
<table>
198202
<tr>
199203
<th>Element</th>
200-
<th>Description</th>
201204
<th>Type</th>
202205
<th>Since</th>
206+
<th>Description</th>
203207
</tr>
204208
<tr>
205-
<td>addClasspath</td>
209+
<td><code>addClasspath</code></td>
210+
<td><code>boolean</code></td>
211+
<td></td>
206212
<td>
207213
Whether to create a <code>Class-Path</code> manifest entry.
208214
The default value is <code>false</code>.
209215
</td>
210-
<td>boolean</td>
211-
<td></td>
212216
</tr>
213217
<tr>
214-
<td>addDefaultEntries</td>
218+
<td><code>addDefaultEntries</code></td>
219+
<td><code>boolean</code></td>
220+
<td>3.4.0</td>
215221
<td>
216222
If the manifest will contain these entries:
217223
<source>
@@ -224,11 +230,11 @@ Java-Version: &#36;{project maven.compiler.release/target}</source>
224230
<a href="./apidocs/org/apache/maven/archiver/BuildHelper.html">BuildHelper.discoverJavaRelease(...)</a> API.<br />
225231
The default value is <code>true</code>.
226232
</td>
227-
<td>boolean</td>
228-
<td>3.4.0</td>
229233
</tr>
230234
<tr>
231-
<td>addDefaultImplementationEntries</td>
235+
<td><code>addDefaultImplementationEntries</code></td>
236+
<td><code>boolean</code></td>
237+
<td>2.1 and 2.6</td>
232238
<td>
233239
If the manifest will contain these entries:
234240
<source>
@@ -237,11 +243,11 @@ Implementation-Version: \${project.version}
237243
Implementation-Vendor: \${project.organization.name}</source>
238244
The default value is <code>false</code>.
239245
</td>
240-
<td>boolean</td>
241-
<td>2.1 and 2.6</td>
242246
</tr>
243247
<tr>
244-
<td>addDefaultSpecificationEntries</td>
248+
<td><code>addDefaultSpecificationEntries</code></td>
249+
<td><code>boolean</code></td>
250+
<td>2.1</td>
245251
<td>
246252
If the manifest will contain these entries:
247253
<source>
@@ -250,11 +256,11 @@ Specification-Version: \${project.artifact.selectedVersion.majorVersion}.\${proj
250256
Specification-Vendor: \${project.organization.name}</source>
251257
The default value is <code>false</code>.
252258
</td>
253-
<td>boolean</td>
254-
<td>2.1</td>
255259
</tr>
256260
<tr>
257-
<td>addBuildEnvironmentEntries</td>
261+
<td><code>addBuildEnvironmentEntries</code></td>
262+
<td><code>boolean</code></td>
263+
<td>3.4.0</td>
258264
<td>
259265
If the manifest will contain these entries:
260266
<source>
@@ -263,21 +269,21 @@ Build-Jdk: ${java.version} (${java.vendor})
263269
Build-Os: ${os.name} (${os.version}; (${os.arch})</source>
264270
The default value is <code>false</code>.
265271
</td>
266-
<td>boolean</td>
267-
<td>3.4.0</td>
268272
</tr>
269273
<tr>
270-
<td>addExtensions</td>
274+
<td><code>addExtensions</code></td>
275+
<td><code>boolean</code></td>
276+
<td></td>
271277
<td>
272278
Whether to create an <code>Extension-List</code> manifest
273279
entry.
274280
The default value is <code>false</code>.
275281
</td>
276-
<td>boolean</td>
277-
<td></td>
278282
</tr>
279283
<tr>
280-
<td>classpathLayoutType</td>
284+
<td><code>classpathLayoutType</code></td>
285+
<td><code>String</code></td>
286+
<td>2.4</td>
281287
<td>
282288
The type of layout to use when formatting entries in the created
283289
<code>Class-Path</code>. Valid values are: <code>simple</code>,
@@ -288,21 +294,21 @@ Build-Os: ${os.name} (${os.version}; (${os.arch})</source>
288294
<b>must</b> also set <code>customClasspathLayout</code>.
289295
The default value is <code>simple</code>.
290296
</td>
291-
<td>String</td>
292-
<td>2.4</td>
293297
</tr>
294298
<tr>
295-
<td>classpathPrefix</td>
299+
<td><code>classpathPrefix</code></td>
300+
<td><code>String</code></td>
301+
<td></td>
296302
<td>
297303
A text that will be prefixed to all your <code>Class-Path</code>
298304
entries.
299305
The default value is <code>&quot;&quot;</code>.
300306
</td>
301-
<td>String</td>
302-
<td></td>
303307
</tr>
304308
<tr>
305-
<td>customClasspathLayout</td>
309+
<td><code>customClasspathLayout</code></td>
310+
<td><code>String</code></td>
311+
<td>2.4</td>
306312
<td>
307313
The layout expression to use when the layout type set in
308314
<code>classpathLayoutType</code> has the value <code>custom</code>.
@@ -315,55 +321,55 @@ Build-Os: ${os.name} (${os.version}; (${os.arch})</source>
315321
<b>Note:</b> If you specify a layout type of <code>custom</code>
316322
you <b>must</b> set this layout expression.
317323
</td>
318-
<td>String</td>
319-
<td>2.4</td>
320324
</tr>
321325
<tr>
322-
<td>mainClass</td>
323-
<td>The <code>Main-Class</code> manifest entry.</td>
324-
<td>String</td>
326+
<td><code>mainClass</code></td>
327+
<td><code>String</code></td>
325328
<td></td>
329+
<td>The <code>Main-Class</code> manifest entry.</td>
326330
</tr>
327331
<tr>
328-
<td>packageName</td>
329-
<td>Package manifest entry.</td>
330-
<td>String</td>
332+
<td><code>packageName</code></td>
333+
<td><code>String</code></td>
331334
<td></td>
335+
<td>Package manifest entry.</td>
332336
</tr>
333337
<tr>
334-
<td>useUniqueVersions</td>
338+
<td><code>useUniqueVersions</code></td>
339+
<td><code>boolean</code></td>
340+
<td>2.4</td>
335341
<td>
336342
Whether to use unique timestamp Snapshot versions rather than -SNAPSHOT versions.
337343
The default value is <code>true</code>.
338344
</td>
339-
<td>boolean</td>
340-
<td>2.4</td>
341345
</tr>
342346
</table>
343347
</subsection>
344348

345349
<a name="class_manifestSection"/>
346350
<subsection name="manifestSection">
351+
<p>The <code>&lt;manifestSection&gt;</code> element configures sections of <code>META-INF/MANIFEST.MF</code>.
352+
The following table lists all of the possible child elements.</p>
347353
<table>
348354
<tr>
349355
<th>Element</th>
350-
<th>Description</th>
351356
<th>Type</th>
352357
<th>Since</th>
358+
<th>Description</th>
353359
</tr>
354360
<tr>
355-
<td>name</td>
361+
<td><code>name</code></td>
362+
<td><code>String</code></td>
363+
<td></td>
356364
<td>
357365
The name of the section.
358366
</td>
359-
<td>String</td>
360-
<td></td>
361367
</tr>
362368
<tr>
363-
<td>manifestEntries</td>
364-
<td>A list of key/value pairs to add to the manifest.</td>
365-
<td>Map</td>
369+
<td><code>manifestEntries</code></td>
370+
<td><code>Map</code></td>
366371
<td></td>
372+
<td>A list of key/value pairs to add to the manifest.</td>
367373
</tr>
368374
</table>
369375
</subsection>

0 commit comments

Comments
 (0)