Added: dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Eclipse.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Eclipse.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Eclipse.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,756 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Eclipse::Eclipse - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script src="../../js/jquery.js"></script> +<script src="../../js/darkfish.js"></script> + +<link href="../../css/fonts.css" rel="stylesheet"> +<link href="../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="class"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../table_of_contents.html#pages">Pages</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + <div id="parent-class-section" class="nav-section"> + <h3>Parent</h3> + + + <p class="link"><a href="../../Object.html">Object</a> + +</div> + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-c-new">::new</a> + + <li ><a href="#method-i-builders">#builders</a> + + <li ><a href="#method-i-builders-3D">#builders=</a> + + <li ><a href="#method-i-classpath_containers">#classpath_containers</a> + + <li ><a href="#method-i-classpath_containers-3D">#classpath_containers=</a> + + <li ><a href="#method-i-classpath_variables">#classpath_variables</a> + + <li ><a href="#method-i-default_classpath_variables">#default_classpath_variables</a> + + <li ><a href="#method-i-exclude_libs">#exclude_libs</a> + + <li ><a href="#method-i-exclude_libs-3D">#exclude_libs=</a> + + <li ><a href="#method-i-name">#name</a> + + <li ><a href="#method-i-natures">#natures</a> + + <li ><a href="#method-i-natures-3D">#natures=</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Eclipse::Eclipse"> + <h1 id="class-Buildr::Eclipse::Eclipse" class="class"> + class Buildr::Eclipse::Eclipse + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-i-name" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">name</span><span + class="attribute-access-type">[W]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-options" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">options</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section> + + + + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Class Methods</h3> + </header> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(project)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-identifier">project</span> + <span class="ruby-ivar">@options</span> = <span class="ruby-constant">Options</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-builders" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + builders() → [b1, b2] + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Returns the Eclipse project builders on the project. + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + They may be derived from the parent project if no specific builders have been set + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + on the project. + </span> + + </div> + + + + <div class="method-description"> + + <p>A builder is an <a href="Eclipse.html">Eclipse</a> background job that +parses the source code to produce built artifacts.</p> + + + + + <div class="method-source-code" id="builders-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 143</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">builders</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> + <span class="ruby-ivar">@builders</span> <span class="ruby-operator">||=</span> [] + <span class="ruby-ivar">@builders</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">flatten</span> + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@builders</span> <span class="ruby-operator">||</span> (<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">builders</span> <span class="ruby-operator">:</span> []) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-builders-3D" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + builders=(builders) + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Sets the Eclipse project builders on the project. + </span> + + </div> + + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="builders-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 132</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">builders=</span>(<span class="ruby-identifier">var</span>) + <span class="ruby-ivar">@builders</span> = <span class="ruby-identifier">arrayfy</span>(<span class="ruby-identifier">var</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-classpath_containers" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + classpath_containers() → [con1, con2] + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Returns the Eclipse project classpath containers on the project. + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + They may be derived from the parent project if no specific classpath containers have been set + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + on the project. + </span> + + </div> + + + + <div class="method-description"> + + <p>A classpath container is an <a href="Eclipse.html">Eclipse</a> +pre-determined ensemble of dependencies made available to the project +classpath.</p> + + + + + <div class="method-source-code" id="classpath_containers-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 99</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">classpath_containers</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> + <span class="ruby-ivar">@classpath_containers</span> <span class="ruby-operator">||=</span> [] + <span class="ruby-ivar">@classpath_containers</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">flatten</span> + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@classpath_containers</span> <span class="ruby-operator">||</span> (<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">classpath_containers</span> <span class="ruby-operator">:</span> []) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-classpath_containers-3D" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + classpath_containers=(cc) + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Sets the Eclipse project classpath containers on the project. + </span> + + </div> + + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="classpath_containers-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 87</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">classpath_containers=</span>(<span class="ruby-identifier">var</span>) + <span class="ruby-ivar">@classpath_containers</span> = <span class="ruby-identifier">arrayfy</span>(<span class="ruby-identifier">var</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-classpath_variables" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + classpath_variables :VAR → '/path/to/location' + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Sets classpath variables to be used for library path substitution + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + on the project. + </span> + + </div> + + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="classpath_variables-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 41</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">classpath_variables</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>) + <span class="ruby-identifier">fail</span> <span class="ruby-string">"eclipse.classpath_variables expects a single hash argument"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> + <span class="ruby-identifier">fail</span> <span class="ruby-string">"eclipse.classpath_variables expects a Hash argument"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">values</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span> + <span class="ruby-comment"># convert keys to strings</span> + <span class="ruby-identifier">values</span> = <span class="ruby-identifier">values</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">inject</span>({}) { <span class="ruby-operator">|</span><span class="ruby-identifier">h</span>, (<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>)<span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">path_to</span>(<span class="ruby-identifier">v</span>); <span class="ruby-identifier">h</span> } + <span class="ruby-ivar">@variables</span> = <span class="ruby-identifier">values</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-ivar">@variables</span> <span class="ruby-operator">||</span> {}) + <span class="ruby-keyword">end</span> + <span class="ruby-ivar">@variables</span> <span class="ruby-operator">||</span> (<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">classpath_variables</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">default_classpath_variables</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-default_classpath_variables" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">default_classpath_variables</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="default_classpath_variables-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">default_classpath_variables</span> + <span class="ruby-identifier">vars</span> = {} + <span class="ruby-identifier">vars</span>[<span class="ruby-value">:SCALA_HOME</span>] = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'SCALA_HOME'</span>] <span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'SCALA_HOME'</span>] + <span class="ruby-identifier">vars</span>[<span class="ruby-value">:JAVA_HOME</span>] = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'JAVA_HOME'</span>] <span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'JAVA_HOME'</span>] + <span class="ruby-identifier">vars</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-exclude_libs" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + exclude_libs() → [lib1, lib2] + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Returns the an array of libraries to be excluded from the generated Eclipse classpath + </span> + + </div> + + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="exclude_libs-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 111</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">exclude_libs</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> + <span class="ruby-ivar">@exclude_libs</span> <span class="ruby-operator">||=</span> [] + <span class="ruby-ivar">@exclude_libs</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">flatten</span> + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@exclude_libs</span> <span class="ruby-operator">||</span> (<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">exclude_libs</span> <span class="ruby-operator">:</span> []) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-exclude_libs-3D" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + exclude_libs=(lib1, lib2) + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Sets libraries to be excluded from the generated Eclipse classpath + </span> + + </div> + + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="exclude_libs-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 124</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">exclude_libs=</span>(<span class="ruby-identifier">libs</span>) + <span class="ruby-ivar">@exclude_libs</span> = <span class="ruby-identifier">arrayfy</span>(<span class="ruby-identifier">libs</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">name</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="name-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 30</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">name</span> + <span class="ruby-keyword">return</span> <span class="ruby-ivar">@name</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@name</span> + <span class="ruby-keyword">return</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">id</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'-'</span>).<span class="ruby-identifier">last</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">short_names</span> + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">id</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-natures" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + natures() → [n1, n2] + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Returns the Eclipse project natures on the project. + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + They may be derived from the parent project if no specific natures have been set + </span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + on the project. + </span> + + </div> + + + + <div class="method-description"> + + <p>An <a href="Eclipse.html">Eclipse</a> project nature is used internally by +<a href="Eclipse.html">Eclipse</a> to determine the aspects of a project.</p> + + + + + <div class="method-source-code" id="natures-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 74</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">natures</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> + <span class="ruby-ivar">@natures</span> <span class="ruby-operator">||=</span> [] + <span class="ruby-ivar">@natures</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">flatten</span> + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@natures</span> <span class="ruby-operator">||</span> (<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">natures</span> <span class="ruby-operator">:</span> []) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-natures-3D" class="method-detail "> + + + <div class="method-heading"> + <span class="method-callseq"> + natures=(natures) + </span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-heading"> + <span class="method-callseq"> + Sets the Eclipse project natures on the project. + </span> + + </div> + + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="natures-3D-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 63</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">natures=</span>(<span class="ruby-identifier">var</span>) + <span class="ruby-ivar">@natures</span> = <span class="ruby-identifier">arrayfy</span>(<span class="ruby-identifier">var</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> +
Added: dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Java.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Java.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Java.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,130 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Eclipse::Java - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script src="../../js/jquery.js"></script> +<script src="../../js/darkfish.js"></script> + +<link href="../../css/fonts.css" rel="stylesheet"> +<link href="../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="module"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../table_of_contents.html#pages">Pages</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + + <div id="includes-section" class="nav-section"> + <h3>Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="../Extension.html">Buildr::Extension</a> + + + </ul> +</div> + + + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Eclipse::Java"> + <h1 id="module-Buildr::Eclipse::Java" class="module"> + module Buildr::Eclipse::Java + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="BUILDER">BUILDER + + <dd> + + + <dt id="CONTAINER">CONTAINER + + <dd> + + + <dt id="NATURE">NATURE + + <dd> + + + </dl> + </section> + + + + + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + Added: dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Options.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Options.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Options.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,274 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class Buildr::Eclipse::Options - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script src="../../js/jquery.js"></script> +<script src="../../js/darkfish.js"></script> + +<link href="../../css/fonts.css" rel="stylesheet"> +<link href="../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="class"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../table_of_contents.html#pages">Pages</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + <div id="parent-class-section" class="nav-section"> + <h3>Parent</h3> + + + <p class="link"><a href="../../Object.html">Object</a> + +</div> + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-c-new">::new</a> + + <li ><a href="#method-i-m2_repo_var">#m2_repo_var</a> + + <li ><a href="#method-i-short_names">#short_names</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-Buildr::Eclipse::Options"> + <h1 id="class-Buildr::Eclipse::Options" class="class"> + class Buildr::Eclipse::Options + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + + <div id="attribute-i-m2_repo_var" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">m2_repo_var</span><span + class="attribute-access-type">[W]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-short_names" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">short_names</span><span + class="attribute-access-type">[W]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section> + + + + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Class Methods</h3> + </header> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(project)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 163</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-identifier">project</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-m2_repo_var" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">m2_repo_var</span><span + class="method-args">(*values)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>The classpath variable used to point at the local maven2 repository. +Example:</p> + +<pre class="ruby"><span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">m2_repo_var</span> = <span class="ruby-string">'M2_REPO'</span> +</pre> + + + + + <div class="method-source-code" id="m2_repo_var-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 170</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">m2_repo_var</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">values</span>) + <span class="ruby-identifier">fail</span> <span class="ruby-node">"m2_repo_var can only accept one value: #{values}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">values</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> + <span class="ruby-ivar">@m2_repo_var</span> = <span class="ruby-identifier">values</span>[<span class="ruby-value">0</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@m2_repo_var</span> <span class="ruby-operator">||</span> (<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">m2_repo_var</span> <span class="ruby-operator">:</span> <span class="ruby-string">'M2_REPO'</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-short_names" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">short_names</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="short_names-source"> + <pre><span class="ruby-comment"># File lib/buildr/ide/eclipse.rb, line 179</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">short_names</span> + <span class="ruby-ivar">@short_names</span> <span class="ruby-operator">||</span> (<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">eclipse</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">short_names</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + Added: dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Plugin.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Plugin.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Plugin.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,130 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Eclipse::Plugin - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script src="../../js/jquery.js"></script> +<script src="../../js/darkfish.js"></script> + +<link href="../../css/fonts.css" rel="stylesheet"> +<link href="../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="module"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../table_of_contents.html#pages">Pages</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + + <div id="includes-section" class="nav-section"> + <h3>Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="../Extension.html">Buildr::Extension</a> + + + </ul> +</div> + + + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Eclipse::Plugin"> + <h1 id="module-Buildr::Eclipse::Plugin" class="module"> + module Buildr::Eclipse::Plugin + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="BUILDERS">BUILDERS + + <dd> + + + <dt id="CONTAINER">CONTAINER + + <dd> + + + <dt id="NATURE">NATURE + + <dd> + + + </dl> + </section> + + + + + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + Added: dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Scala.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Scala.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Eclipse/Scala.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,130 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Eclipse::Scala - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script src="../../js/jquery.js"></script> +<script src="../../js/darkfish.js"></script> + +<link href="../../css/fonts.css" rel="stylesheet"> +<link href="../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="module"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../table_of_contents.html#pages">Pages</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + + <div id="includes-section" class="nav-section"> + <h3>Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="../Extension.html">Buildr::Extension</a> + + + </ul> +</div> + + + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Eclipse::Scala"> + <h1 id="module-Buildr::Eclipse::Scala" class="module"> + module Buildr::Eclipse::Scala + </h1> + + <section class="description"> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="BUILDER">BUILDER + + <dd> + + + <dt id="CONTAINER">CONTAINER + + <dd> + + + <dt id="NATURE">NATURE + + <dd> + + + </dl> + </section> + + + + + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + Added: dev/buildr/1.5.8/site/rdoc/Buildr/Emma.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Emma.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Emma.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,325 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Emma - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script src="../js/jquery.js"></script> +<script src="../js/darkfish.js"></script> + +<link href="../css/fonts.css" rel="stylesheet"> +<link href="../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="module"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../table_of_contents.html#pages">Pages</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-c-ant">::ant</a> + + <li ><a href="#method-c-data_file">::data_file</a> + + <li ><a href="#method-c-dependencies">::dependencies</a> + + <li ><a href="#method-c-report_to">::report_to</a> + + <li ><a href="#method-c-version">::version</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Emma"> + <h1 id="module-Buildr::Emma" class="module"> + module Buildr::Emma + </h1> + + <section class="description"> + +<p>Provides the <code>emma:html</code> and <code>emma:xml</code> tasks. +Require explicitly using <code>require "buildr/emma"</code>.</p> + +<p>You can generate emma reports for a single project using the project name +as prefix:</p> + +<pre>project_name:emma:html</pre> + +<p>You can also specify which classes to include/exclude from instrumentation +by passing a class name regexp to the <code>emma.include</code> or +<code>emma.exclude</code> methods.</p> + +<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'someModule'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">emma</span>.<span class="ruby-identifier">include</span> <span class="ruby-string">'some.package.*'</span> + <span class="ruby-identifier">emma</span>.<span class="ruby-identifier">exclude</span> <span class="ruby-string">'some.foo.util.SimpleUtil'</span> +<span class="ruby-keyword">end</span> +</pre> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + + <dt id="VERSION">VERSION + + <dd> + + + </dl> + </section> + + + + + + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Class Methods</h3> + </header> + + + <div id="method-c-ant" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ant</span><span + class="method-args">() { |ant| ... }</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="ant-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/emma.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ant</span> + + <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">ant</span> <span class="ruby-string">'emma'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ant</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">ant</span>.<span class="ruby-identifier">taskdef</span> <span class="ruby-value">:resource=</span><span class="ruby-operator">></span><span class="ruby-string">'emma_ant.properties'</span>, + <span class="ruby-value">:classpath=</span><span class="ruby-operator">></span><span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">artifacts</span>(<span class="ruby-identifier">dependencies</span>).<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-value">:invoke</span>).<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:to_s</span>).<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>) + <span class="ruby-identifier">ant</span>.<span class="ruby-identifier">emma</span> <span class="ruby-value">:verbosity=</span><span class="ruby-operator">></span>(<span class="ruby-identifier">trace?</span>(<span class="ruby-value">:emma</span>) <span class="ruby-operator">?</span> <span class="ruby-string">'verbose'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'warning'</span>) <span class="ruby-keyword">do</span> + <span class="ruby-keyword">yield</span> <span class="ruby-identifier">ant</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-c-data_file" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">data_file</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="data_file-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/emma.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">data_file</span>() + <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">report_to</span>, <span class="ruby-string">'coverage.es'</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-c-dependencies" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">dependencies</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="dependencies-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/emma.rb, line 44</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">dependencies</span> + <span class="ruby-ivar">@dependencies</span> <span class="ruby-operator">||=</span> [<span class="ruby-node">"emma:emma_ant:jar:#{version}"</span>, <span class="ruby-node">"emma:emma:jar:#{version}"</span>] +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-c-report_to" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">report_to</span><span + class="method-args">(format=nil)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="report_to-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/emma.rb, line 48</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">report_to</span> <span class="ruby-identifier">format</span>=<span class="ruby-keyword">nil</span> + <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-string">'reports/emma'</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-c-version" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">version</span><span + class="method-args">()</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="version-source"> + <pre><span class="ruby-comment"># File lib/buildr/java/emma.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">version</span> + <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">build</span>[<span class="ruby-string">'emma'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">VERSION</span> +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + Added: dev/buildr/1.5.8/site/rdoc/Buildr/Extension.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Extension.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Extension.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,190 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Extension - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script src="../js/jquery.js"></script> +<script src="../js/darkfish.js"></script> + +<link href="../css/fonts.css" rel="stylesheet"> +<link href="../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="module"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../table_of_contents.html#pages">Pages</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + + + <div id="extends-section" class="nav-section"> + <h3>Extended With Modules</h3> + + <ul class="link-list"> + + + <li><a class="extend" href="Extension/ClassMethods.html">Buildr::Extension::ClassMethods</a> + + + </ul> +</div> + + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Extension"> + <h1 id="module-Buildr::Extension" class="module"> + module Buildr::Extension + </h1> + + <section class="description"> + +<p>The basic mechanism for extending projects in <a +href="../Buildr.html">Buildr</a> are Ruby modules. In fact, base features +like compiling and testing are all developed in the form of modules, and +then added to the core <a href="Project.html">Project</a> class.</p> + +<p>A module defines instance methods that are then mixed into the project and +become instance methods of the project. There are two general ways for +extending projects. You can extend all projects by including the module in +Project:</p> + +<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Project</span> + <span class="ruby-identifier">include</span> <span class="ruby-constant">MyExtension</span> +<span class="ruby-keyword">end</span> +</pre> + +<p>You can also extend a given project instance and only that instance by +extending it with the module:</p> + +<pre class="ruby"><span class="ruby-identifier">define</span> <span class="ruby-string">'foo'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">extend</span> <span class="ruby-constant">MyExtension</span> +<span class="ruby-keyword">end</span> +</pre> + +<p>Some extensions require tighter integration with the project, specifically +for setting up tasks and properties, or for configuring tasks based on the +project definition. You can do that by adding callbacks to the process.</p> + +<p>The easiest way to add callbacks is by incorporating the <a +href="Extension.html">Extension</a> module in your own extension, and using +the various class methods to define callback behavior:</p> +<ul><li> +<p>first_time â This block will be called once for any particular extension.</p> + +<pre>You can use this to setup top-level and local tasks.</pre> +</li><li> +<p>before_define â This block is called once for the project with the project</p> + +<pre>instance, right before running the project definition. You can use this +to add tasks and set properties that will be used in the project definition.</pre> +</li><li> +<p>after_define â This block is called once for the project with the project</p> + +<pre>instance, right after running the project definition. You can use this to +do any post-processing that depends on the project definition.</pre> +</li></ul> + +<p>This example illustrates how to write a simple extension:</p> + +<pre class="ruby"><span class="ruby-keyword">module</span> <span class="ruby-constant">LinesOfCode</span> + <span class="ruby-identifier">include</span> <span class="ruby-constant">Extension</span> + + <span class="ruby-identifier">first_time</span> <span class="ruby-keyword">do</span> + <span class="ruby-comment"># Define task not specific to any projet.</span> + <span class="ruby-identifier">desc</span> <span class="ruby-string">'Count lines of code in current project'</span> + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">local_task</span>(<span class="ruby-string">'loc'</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">before_define</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project</span><span class="ruby-operator">|</span> + <span class="ruby-comment"># Define the loc task for this particular project.</span> + <span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">Task</span>.<span class="ruby-identifier">define_task</span> <span class="ruby-string">'loc'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">task</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">lines</span> = <span class="ruby-identifier">task</span>.<span class="ruby-identifier">prerequisites</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span> <span class="ruby-constant">Dir</span>[<span class="ruby-string">'#{path} /*'</span>] }.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">uniq</span>. + <span class="ruby-identifier">inject</span>(<span class="ruby-value">0</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">total</span>, <span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">total</span> <span class="ruby-operator">+</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">readlines</span>(<span class="ruby-identifier">file</span>).<span class="ruby-identifier">count</span> } + <span class="ruby-identifier">puts</span> <span class="ruby-node">"Project #{project.name} has #{lines} lines of code"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">after_define</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project</span><span class="ruby-operator">|</span> + <span class="ruby-comment"># Now that we know all the source directories, add them.</span> + <span class="ruby-identifier">task</span>(<span class="ruby-string">'loc'</span>=<span class="ruby-operator">></span><span class="ruby-identifier">compile</span>.<span class="ruby-identifier">sources</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">compile</span>.<span class="ruby-identifier">test</span>.<span class="ruby-identifier">sources</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># To use this method in your project:</span> + <span class="ruby-comment"># loc path_1, path_2</span> + <span class="ruby-keyword">def</span> <span class="ruby-identifier">loc</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">paths</span>) + <span class="ruby-identifier">task</span>(<span class="ruby-string">'loc'</span>=<span class="ruby-operator">></span><span class="ruby-identifier">paths</span>) + <span class="ruby-keyword">end</span> + +<span class="ruby-keyword">end</span> + +<span class="ruby-keyword">class</span> <span class="ruby-constant">Buildr</span><span class="ruby-operator">::</span><span class="ruby-constant">Project</span> + <span class="ruby-identifier">include</span> <span class="ruby-constant">LinesOfCode</span> +<span class="ruby-keyword">end</span> +</pre> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + Added: dev/buildr/1.5.8/site/rdoc/Buildr/Extension/ClassMethods.html ============================================================================== --- dev/buildr/1.5.8/site/rdoc/Buildr/Extension/ClassMethods.html (added) +++ dev/buildr/1.5.8/site/rdoc/Buildr/Extension/ClassMethods.html Sun Jul 14 11:16:56 2019 @@ -0,0 +1,259 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>module Buildr::Extension::ClassMethods - buildr</title> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script src="../../js/jquery.js"></script> +<script src="../../js/darkfish.js"></script> + +<link href="../../css/fonts.css" rel="stylesheet"> +<link href="../../css/rdoc.css" rel="stylesheet"> + + + +<body id="top" role="document" class="module"> +<nav role="navigation"> + <div id="project-navigation"> + <div id="home-section" role="region" title="Quick navigation" class="nav-section"> + <h2> + <a href="../../index.html" rel="home">Home</a> + </h2> + + <div id="table-of-contents-navigation"> + <a href="../../table_of_contents.html#pages">Pages</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </div> +</div> + + <div id="search-section" role="search" class="project-section initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <div id="search-field-wrapper"> + <input id="search-field" role="combobox" aria-label="Search" + aria-autocomplete="list" aria-controls="search-results" + type="text" name="search" placeholder="Search" spellcheck="false" + title="Type to search, Up and Down to navigate, Enter to load"> + </div> + + <ul id="search-results" aria-label="Search Results" + aria-busy="false" aria-expanded="false" + aria-atomic="false" class="initially-hidden"></ul> + </form> +</div> + + </div> + + + + <div id="class-metadata"> + + + + + <!-- Method Quickref --> +<div id="method-list-section" class="nav-section"> + <h3>Methods</h3> + + <ul class="link-list" role="directory"> + + <li ><a href="#method-i-after_define">#after_define</a> + + <li ><a href="#method-i-before_define">#before_define</a> + + <li ><a href="#method-i-first_time">#first_time</a> + + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="module-Buildr::Extension::ClassMethods"> + <h1 id="module-Buildr::Extension::ClassMethods" class="module"> + module Buildr::Extension::ClassMethods + </h1> + + <section class="description"> + +<p>Methods added to the extension module when including <a +href="../Extension.html">Extension</a>.</p> + + </section> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-after_define" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_define</span><span + class="method-args">(*args, &block)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>This block is called once for the project with the project instance, right +after running the project definition. You can use this to do any +post-processing that depends on the project definition.</p> + +<p>The block may be named and dependencies may be declared similar to <a +href="../../Rake.html">Rake</a> task dependencies:</p> + +<pre class="ruby"><span class="ruby-identifier">after_define</span>(:<span class="ruby-identifier">my_setup</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project</span><span class="ruby-operator">|</span> + <span class="ruby-comment"># do stuff on project</span> +<span class="ruby-keyword">end</span> + +<span class="ruby-comment"># my_setup code must run before :compile (but only after project is defined)</span> +<span class="ruby-identifier">after_define</span>(:<span class="ruby-identifier">compile</span> =<span class="ruby-operator">></span> :<span class="ruby-identifier">my_setup</span>) +</pre> + + + + + <div class="method-source-code" id="after_define-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 860</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_define</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">name</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">name</span> + <span class="ruby-identifier">deps</span> = [] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">name</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">module_callbacks</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Callback</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:after_define</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">deps</span>, <span class="ruby-identifier">block</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-before_define" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">before_define</span><span + class="method-args">(*args, &block)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>This block is called once for the project with the project instance, right +before running the project definition. You can use this to add tasks and +set properties that will be used in the project definition.</p> + +<p>The block may be named and dependencies may be declared similar to <a +href="../../Rake.html">Rake</a> task dependencies:</p> + +<pre class="ruby"><span class="ruby-identifier">before_define</span>(:<span class="ruby-identifier">my_setup</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project</span><span class="ruby-operator">|</span> + <span class="ruby-comment"># do stuff on project</span> +<span class="ruby-keyword">end</span> + +<span class="ruby-comment"># my_setup code must run before :compile</span> +<span class="ruby-identifier">before_define</span>(:<span class="ruby-identifier">compile</span> =<span class="ruby-operator">></span> :<span class="ruby-identifier">my_setup</span>) +</pre> + + + + + <div class="method-source-code" id="before_define-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 836</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">before_define</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">name</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">name</span> + <span class="ruby-identifier">deps</span> = [] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">name</span>, <span class="ruby-identifier">args</span>, <span class="ruby-identifier">deps</span> = <span class="ruby-constant">Buildr</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">resolve_args</span>(<span class="ruby-identifier">args</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">module_callbacks</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Callback</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:before_define</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">deps</span>, <span class="ruby-identifier">block</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + <div id="method-i-first_time" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">first_time</span><span + class="method-args">(&block)</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + <p>This block will be called once for any particular extension included in <a +href="../Project.html">Project</a>. You can use this to setup top-level and +local tasks.</p> + + + + + <div class="method-source-code" id="first_time-source"> + <pre><span class="ruby-comment"># File lib/buildr/core/project.rb, line 818</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">first_time</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) + <span class="ruby-identifier">module_callbacks</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Callback</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:first_time</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">name</span>, [], <span class="ruby-identifier">block</span>) +<span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + </section> +</main> + + +<footer id="validator-badges" role="contentinfo"> + <p><a href="http://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> +