lein-adl/docs/leiningen.adl.html
2019-05-02 16:20:57 +01:00

11 lines
2.7 KiB
HTML

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>leiningen.adl documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Lein-adl</span> <span class="project-version">0.1.7</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="leiningen.adl.html"><div class="inner"><span>leiningen.adl</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="leiningen.adl.html#var-adl"><div class="inner"><span>adl</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">leiningen.adl</h1><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="public anchor" id="var-adl"><h3>adl</h3><div class="usage"><code>(adl project &amp; args)</code></div><div class="doc"><div class="markdown"><p>Process an Application Description Language file using configuration taken from the <code>project.clj</code>.</p>
<p>A key <code>:adl</code> may be supplied, whose value should be a map with some or all of the following keys:</p>
<ul>
<li><code>:adl-file</code> the filename of the ADL file to generate from (defaults to <code>[project-name].adl.xml</code>);</li>
<li><code>:locale</code> the locale to generate files for (defaults to your default locale);</li>
<li><code>:path</code> the path under which to generate files (defaults to the current directory);</li>
<li><code>:verbosity</code> if set to an integer greater than zero, will print additional information about what ADL is doing.</li>
</ul>
<p>Additionally, the name of an ADL file may be supplied as an argument, in which case that file will be used in preference to any specified in the <code>project.clj</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/lein-adl/blob/master/src/leiningen/adl.clj#L18">view source</a></div></div></div></body></html>