erik/kobalt-doc
erik/kobalt-doc
1
0
Fork 0
mirror of https://github.com/ethauvin/kobalt-doc.git synced 2025-04-25 20:07:11 -07:00
Code Releases Activity

Refactoring toc.

Browse source
This commit is contained in:
Cedric Beust 2015-10-08 21:26:02 -07:00
parent 6392d6965c
commit 0a49785494
4 changed files with 30 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

14
plugins/index.html
View file

@ -72,7 +72,7 @@ val p = javaProject(wrapper) {
Both these directives allow you to consider an object of type <code><a href="https://github.com/cbeust/kobalt/blob/master/src/main/kotlin/com/beust/kobalt/api/Project.kt">Project</code></a>.
</p>
<h3 class="section" indent="..">Project</h3>
<h3 class="section" indent="1">Project</h3>
<p>
A <code>Project</code> has two mandatory attributes: <code>name</code> and <code>version</code>. If you are planning to deploy your project to a Maven repository, you also have to specify its <code>group</code> (e.g. <code>com.beust</code>) and <code>artifactId</code> (e.g. <code>kobalt</code>).
@ -92,7 +92,7 @@ A <code>Project</code> has two mandatory attributes: <code>name</code> and <code
<dd>The dependencies for your tests</dd>
</dl>
<h3 class="section" indent="..">Tasks</h3>
<h3 class="section" indent="1">Tasks</h3>
<p>
Once you have at least one project configured, the plug-in lets you invoke the following tasks:
<dl class="dl-horizontal">
@ -122,13 +122,13 @@ val packaging = assemble(kobalt) {
If you don't specify a <code>name</code> for your archive, a default one will be used that contains your project name, version and the corresponding suffix, e.g. <code>kobalt-1.1.jar</code> or <code>sec-0.2.war</code>.
</p>
<h3 class="section" indent="..">zip</h3>
<h3 class="section" indent="1">zip</h3>
<p>
All these archives are zip files, so the <code>zip</code> archive is at the top of the hierarchy and <code>jar</code> and <code>war</code> inherit all its attributes, which include <code>name</code>, <code>include</code> and <code>exclude</code>.
</p>
<h3 class="section" indent="..">include and exclude</h3>
<h3 class="section" indent="1">include and exclude</h3>
<p>
All archives let you include and exclude files.
@ -153,7 +153,7 @@ val a = assemble(kobalt) {
The first form, with just one parameter, simply copies the file from your directory into the archive, preserving its path. The second form has three parameters which allow you to move the file to a different path into your archive. Note the use of the <code>from</code>, <code>to</code> and <code>glob</code> directives, which are necessary to disambiguate the call.
</p>
<h3 class="section" indent="..">jar</h3>
<h3 class="section" indent="1">jar</h3>
<p>
A <code>jar</code> is like a <code>zip</code> with two additional available parameters:
@ -182,13 +182,13 @@ val a = assemble(kobalt) {
</pre>
<h3 class="section" indent="..">war</h3>
<h3 class="section" indent="1">war</h3>
<p>
The <code>war</code> directive generates a war file suitable to be deployed into a servlet container.
</p>
<h3 class="section" indent="..">mavenJars</h3>
<h3 class="section" indent="1">mavenJars</h3>
<p>
The <code>mavenJars</code> directive generates several jar files (binary, source, javadoc) which are required by Maven repositories. It's basically a shortcut that saves you the trouble from having to assemble these jar files manually in your build file. It allows you to specify Manifest attributes, just like the <code>jar</code> directive.