Skip to content

Commit 7ff2851

Browse files
committed
Autodoc commit for master/401c51f3
1 parent abb1d6a commit 7ff2851

3 files changed

Lines changed: 82 additions & 18 deletions

File tree

api-index.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ <h2 id="E"><span id="section-head">E</span></h2>
9696
</div><div id="index-body">
9797
<h2 id="F"><span id="section-head">F</span></h2>
9898
<pre>
99-
99+
<span id="section-content"> <a href="index.html#clojure.tools.cli/format-lines">format-lines</a><span id="line-content"> function clojure.tools.cli Format a sequence of summary parts into columns. l...
100+
</span></span>
100101
</pre>
101102
</div><div id="index-body">
102103
<h2 id="G"><span id="section-head">G</span></h2>
@@ -132,7 +133,8 @@ <h2 id="L"><span id="section-head">L</span></h2>
132133
</div><div id="index-body">
133134
<h2 id="M"><span id="section-head">M</span></h2>
134135
<pre>
135-
136+
<span id="section-content"> <a href="index.html#clojure.tools.cli/make-summary-part">make-summary-part</a><span id="line-content"> function clojure.tools.cli Given a single compiled option spec, turn it into ...
137+
</span></span>
136138
</pre>
137139
</div><div id="index-body">
138140
<h2 id="N"><span id="section-head">N</span></h2>

index-0.3.4.clj

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
:wiki-url
66
"http://clojure.github.com/tools.cli/clojure.tools.cli-api.html",
77
:source-url
8-
"https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj"}),
8+
"https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj"}),
99
:vars
1010
({:raw-source-url
11-
"https://github.com/clojure/tools.cli/raw/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj",
11+
"https://github.com/clojure/tools.cli/raw/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj",
1212
:name "cli",
1313
:file "src/main/clojure/clojure/tools/cli.clj",
1414
:source-url
15-
"https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L180",
15+
"https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L180",
1616
:line 180,
1717
:var-type "function",
1818
:arglists ([args & specs]),
@@ -22,13 +22,28 @@
2222
:wiki-url
2323
"http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/cli"}
2424
{:raw-source-url
25-
"https://github.com/clojure/tools.cli/raw/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj",
25+
"https://github.com/clojure/tools.cli/raw/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj",
26+
:added "0.3.0",
27+
:name "format-lines",
28+
:file "src/main/clojure/clojure/tools/cli.clj",
29+
:source-url
30+
"https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L432",
31+
:line 432,
32+
:var-type "function",
33+
:arglists ([lens parts]),
34+
:doc
35+
"Format a sequence of summary parts into columns. lens is a sequence of\nlengths to use for parts. There are two sequences of lengths if we are\nnot displaying defaults. There are three sequences of lengths if we\nare showing defaults.",
36+
:namespace "clojure.tools.cli",
37+
:wiki-url
38+
"http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/format-lines"}
39+
{:raw-source-url
40+
"https://github.com/clojure/tools.cli/raw/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj",
2641
:added "0.3.2",
2742
:name "get-default-options",
2843
:file "src/main/clojure/clojure/tools/cli.clj",
2944
:source-url
30-
"https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L458",
31-
:line 458,
45+
"https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L466",
46+
:line 466,
3247
:var-type "function",
3348
:arglists ([option-specs]),
3449
:doc
@@ -37,13 +52,28 @@
3752
:wiki-url
3853
"http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/get-default-options"}
3954
{:raw-source-url
40-
"https://github.com/clojure/tools.cli/raw/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj",
55+
"https://github.com/clojure/tools.cli/raw/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj",
56+
:added "0.3.0",
57+
:name "make-summary-part",
58+
:file "src/main/clojure/clojure/tools/cli.clj",
59+
:source-url
60+
"https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L416",
61+
:line 416,
62+
:var-type "function",
63+
:arglists ([show-defaults? spec]),
64+
:doc
65+
"Given a single compiled option spec, turn it into a formatted string,\noptionally with its default values if requested.",
66+
:namespace "clojure.tools.cli",
67+
:wiki-url
68+
"http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/make-summary-part"}
69+
{:raw-source-url
70+
"https://github.com/clojure/tools.cli/raw/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj",
4171
:added "0.3.0",
4272
:name "parse-opts",
4373
:file "src/main/clojure/clojure/tools/cli.clj",
4474
:source-url
45-
"https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L463",
46-
:line 463,
75+
"https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L471",
76+
:line 471,
4777
:var-type "function",
4878
:arglists ([args option-specs & options]),
4979
:doc
@@ -52,13 +82,13 @@
5282
:wiki-url
5383
"http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/parse-opts"}
5484
{:raw-source-url
55-
"https://github.com/clojure/tools.cli/raw/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj",
85+
"https://github.com/clojure/tools.cli/raw/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj",
5686
:added "0.3.0",
5787
:name "summarize",
5888
:file "src/main/clojure/clojure/tools/cli.clj",
5989
:source-url
60-
"https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L443",
61-
:line 443,
90+
"https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L451",
91+
:line 451,
6292
:var-type "function",
6393
:arglists ([specs]),
6494
:doc

index.html

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,15 @@ <h1 class="nopad">Table of Contents</h1>
5656
<div class="toc-entry" style="margin-left: 1em;">
5757
<a href="#clojure.tools.cli/cli" class="toc-entry-anchor">cli</a>
5858

59+
</div><div class="toc-entry" style="margin-left: 1em;">
60+
<a href="#clojure.tools.cli/format-lines" class="toc-entry-anchor">format-lines</a>
61+
5962
</div><div class="toc-entry" style="margin-left: 1em;">
6063
<a href="#clojure.tools.cli/get-default-options" class="toc-entry-anchor">get-default-options</a>
6164

65+
</div><div class="toc-entry" style="margin-left: 1em;">
66+
<a href="#clojure.tools.cli/make-summary-part" class="toc-entry-anchor">make-summary-part</a>
67+
6268
</div><div class="toc-entry" style="margin-left: 1em;">
6369
<a href="#clojure.tools.cli/parse-opts" class="toc-entry-anchor">parse-opts</a>
6470

@@ -114,7 +120,21 @@ <h2 id="clojure.tools.cli/cli">cli</h2>
114120
documentation banner to provide usage instructions.</pre>
115121

116122

117-
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L180">Source</a>
123+
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L180">Source</a>
124+
</div><div id="var-entry">
125+
<br />
126+
<hr />
127+
<h2 id="clojure.tools.cli/format-lines">format-lines</h2>
128+
<span id="var-type">function</span><br />
129+
<pre id="var-usage">Usage: (format-lines lens parts)
130+
</pre>
131+
<pre id="var-docstr">Format a sequence of summary parts into columns. lens is a sequence of
132+
lengths to use for parts. There are two sequences of lengths if we are
133+
not displaying defaults. There are three sequences of lengths if we
134+
are showing defaults.</pre>
135+
<span class="var-added"><span id="content">Added in Command-line processor version 0.3.0</span><br /></span>
136+
137+
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L432">Source</a>
118138
</div><div id="var-entry">
119139
<br />
120140
<hr />
@@ -125,7 +145,19 @@ <h2 id="clojure.tools.cli/get-default-options">get-default-options</h2>
125145
<pre id="var-docstr">Extract the map of default options from a sequence of option vectors.</pre>
126146
<span class="var-added"><span id="content">Added in Command-line processor version 0.3.2</span><br /></span>
127147

128-
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L458">Source</a>
148+
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L466">Source</a>
149+
</div><div id="var-entry">
150+
<br />
151+
<hr />
152+
<h2 id="clojure.tools.cli/make-summary-part">make-summary-part</h2>
153+
<span id="var-type">function</span><br />
154+
<pre id="var-usage">Usage: (make-summary-part show-defaults? spec)
155+
</pre>
156+
<pre id="var-docstr">Given a single compiled option spec, turn it into a formatted string,
157+
optionally with its default values if requested.</pre>
158+
<span class="var-added"><span id="content">Added in Command-line processor version 0.3.0</span><br /></span>
159+
160+
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L416">Source</a>
129161
</div><div id="var-entry">
130162
<br />
131163
<hr />
@@ -254,7 +286,7 @@ <h2 id="clojure.tools.cli/parse-opts">parse-opts</h2>
254286
</pre>
255287
<span class="var-added"><span id="content">Added in Command-line processor version 0.3.0</span><br /></span>
256288

257-
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L463">Source</a>
289+
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L471">Source</a>
258290
</div><div id="var-entry">
259291
<br />
260292
<hr />
@@ -269,7 +301,7 @@ <h2 id="clojure.tools.cli/summarize">summarize</h2>
269301
your user-supplied :summary-fn option) on the compiled option specs.</pre>
270302
<span class="var-added"><span id="content">Added in Command-line processor version 0.3.0</span><br /></span>
271303

272-
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/289232fc40bf57418d1c2e1cafb205460a023c94/src/main/clojure/clojure/tools/cli.clj#L443">Source</a>
304+
<a id="var-source" href="https://github.com/clojure/tools.cli/blob/401c51f3c2c5c549b9b4713951e41ed20cfcc4d7/src/main/clojure/clojure/tools/cli.clj#L451">Source</a>
273305
</div>
274306
</div>
275307

0 commit comments

Comments
 (0)