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

Document property changes.

Browse source
This commit is contained in:
Cedric Beust 2015-11-15 09:58:29 -08:00
parent 0f303a044e
commit 0ed7c19be0
1 changed files with 30 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

34
plug-in-development/index.html
View file

@ -395,25 +395,49 @@ kobalt-line-count:exampleTask
<h2 class="section" id="properties">Properties</h2> <h2 class="section" id="properties">Properties</h2>
<p> <p>
Properties are the mechanism that plug-ins can use to export values and also read values that other Properties are the mechanism that plug-ins can use to export values and also read values that other
plug-ins have exported. The <code>PluginProperties</code> instance can be found on the <code>KobaltContext</code> plug-ins have exported. There are two kinds of properties that plug-ins can manipulate:
</p>
<ul>
<li><strong>Project properties</strong>: project-specific properties.</li>
<li><strong>Plug-in properties</strong>: general properties that are applicable to no project
in particular.</li>
</ul>
<h3 class="section" indent="1" id="project-properties">Project properties</h3>
<p>
<code>Project</code> instances have a property called <code>projectProperties</code> that is an
instance of the <code>ProjectProperties</code> class. Plugins can put and get values on this
object in order to store project specific properties.
</p>
<pre class="brush:java">
fun taskAssemble(project: Project) : TaskResult {
project.projectProperties.put(PACKAGES, packages)
</pre>
<h3 class="section" indent="1" id="plugin-properties">Plug-in properties</h3>
<p>
The <code>PluginProperties</code> instance can be found on the <code>KobaltContext</code>
object that your plug-in receives in its <code>apply()</code> method. Once you have an instance of this object that your plug-in receives in its <code>apply()</code> method. Once you have an instance of this
class, you can read or write variables into it: class, you can read or write variables into it:
</p> </p>
<pre> <pre>
override fun apply(project: Project, context: KobaltContext) { override fun apply(project: Project, context: KobaltContext) {
// Export a property for other plug-ins to use // Export a property for other plug-ins to use
context.pluginProperties.put(name, BUILD_DIR, project.buildDirectory) context.pluginProperties.put(PLUGIN_NAME, "somePluginProperty", "someValue")
// Read a property from another plug-in // Read a property from another plug-in
val sourceDir = context.pluginProperties.get("somePlugin", "someProperty") val sourceDir = context.pluginProperties.get("pluginName", "somePluginProperty")
} }
</pre> </pre>
<h3 class="section" indent="1" id="documenting-properties">Documenting properties</h3>
<p> <p>
Plug-ins that define properties should annotate them with the <code>@ExportedProperty</code> annotation: Plug-ins that define properties should annotate them with the <code>@ExportedPluginProperty</code> or
<code>@ExportedProjectProperty</code>annotation:
</p> </p>
<pre> <pre>
companion object { companion object {
@ExportedProperty @ExportedProjectProperty
const val BUILD_DIR = "buildDir" const val BUILD_DIR = "buildDir"
</pre> </pre>