Skip to content

Commit

Permalink
updated for R14B02 & layout fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Ulf Wiger committed Mar 24, 2011
1 parent 5ca2ed6 commit 56d4aae
Show file tree
Hide file tree
Showing 8 changed files with 412 additions and 131 deletions.
10 changes: 5 additions & 5 deletions doc/edown_doclet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,22 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#run-2">run/2</a></td><td>Main doclet entry point.</td></tr></table>


<a name="functions"></a>


<h2>Function Details</h2>
<h2><a name="functions">Function Details</a></h2>


<a name="run-2"></a>


<h3>run/2</h3>





<tt>runfun((Command::<a href="#type-doclet_gen">doclet_gen()</a> | <a href="#type-doclet_toc">doclet_toc()</a>, Ctxt::<a href="#type-edoc_context">edoc_context()</a>) -> ok)</tt>
`run(Command::[doclet_gen()](#type-doclet_gen) | [doclet_toc()](#type-doclet_toc), Ctxt::[edoc_context()](#type-edoc_context)) -> ok`
<br></br>




Expand Down Expand Up @@ -150,4 +150,4 @@ will be copied to the target directory.



_Generated by EDoc, Mar 23 2011, 18:36:45._
_Generated by EDoc, Mar 24 2011, 12:34:30._
33 changes: 19 additions & 14 deletions doc/edown_layout.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,13 @@ The module is intended to be used together with edoc.
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#markdown-3">markdown/3</a></td><td></td></tr><tr><td valign="top"><a href="#module-2">module/2</a></td><td>The layout function.</td></tr><tr><td valign="top"><a href="#overview-2">overview/2</a></td><td></td></tr><tr><td valign="top"><a href="#package-2">package/2</a></td><td></td></tr><tr><td valign="top"><a href="#type-1">type/1</a></td><td></td></tr></table>


<a name="functions"></a>


<h2>Function Details</h2>
<h2><a name="functions">Function Details</a></h2>


<a name="markdown-3"></a>


<h3>markdown/3</h3>


Expand All @@ -46,10 +44,8 @@ The module is intended to be used together with edoc.

`markdown(Title, CSS, Body) -> any()`


<a name="module-2"></a>


<h3>module/2</h3>


Expand Down Expand Up @@ -81,6 +77,21 @@ index tables. The default value is 1.



<dt><code>{pretty_printer, atom()}</code>
</dt>




<dd>Specifies how types and specifications are pretty printed.
If the value <code>erl_pp</code> is specified the Erlang pretty printer
(the module <code>erl_pp</code>) will be used. The default is to do
no pretty printing which implies that lines can be very long.
</dd>




<dt><code>{stylesheet, string()}</code>
</dt>

Expand All @@ -95,7 +106,7 @@ specified, no stylesheet reference will be generated.



<dt><code>{sort_functions, bool()}</code>
<dt><code>{sort_functions, boolean()}</code>
</dt>


Expand Down Expand Up @@ -123,9 +134,7 @@ used for exporting the documentation. See <a href="http://www.erlang.org/doc/man



__See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#layout-2), [edown_doclet:layout/2](edown_doclet.md#layout-2).
<a name="overview-2"></a>

__See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#layout-2), [edown_doclet:layout/2](edown_doclet.md#layout-2).<a name="overview-2"></a>

<h3>overview/2</h3>

Expand All @@ -135,10 +144,8 @@ __See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#lay

`overview(E, Options) -> any()`


<a name="package-2"></a>


<h3>package/2</h3>


Expand All @@ -147,10 +154,8 @@ __See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#lay

`package(E, Options) -> any()`


<a name="type-1"></a>


<h3>type/1</h3>


Expand All @@ -161,4 +166,4 @@ __See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#lay



_Generated by EDoc, Mar 23 2011, 18:36:45._
_Generated by EDoc, Mar 24 2011, 12:34:30._
10 changes: 2 additions & 8 deletions doc/edown_lib.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,13 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#export-1">export/1</a></td><td></td></tr><tr><td valign="top"><a href="#get_attrval-2">get_attrval/2</a></td><td></td></tr><tr><td valign="top"><a href="#redirect_uri-1">redirect_uri/1</a></td><td></td></tr></table>


<a name="functions"></a>


<h2>Function Details</h2>
<h2><a name="functions">Function Details</a></h2>


<a name="export-1"></a>


<h3>export/1</h3>


Expand All @@ -41,10 +39,8 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla

`export(Data) -> any()`


<a name="get_attrval-2"></a>


<h3>get_attrval/2</h3>


Expand All @@ -53,10 +49,8 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla

`get_attrval(Name, XmlElement) -> any()`


<a name="redirect_uri-1"></a>


<h3>redirect_uri/1</h3>


Expand All @@ -67,4 +61,4 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla



_Generated by EDoc, Mar 23 2011, 18:36:45._
_Generated by EDoc, Mar 24 2011, 12:34:30._
12 changes: 2 additions & 10 deletions doc/edown_xmerl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,13 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#%23element%23-5">'#element#'/5</a></td><td></td></tr><tr><td valign="top"><a href="#%23root%23-4">'#root#'/4</a></td><td></td></tr><tr><td valign="top"><a href="#%23text%23-1">'#text#'/1</a></td><td></td></tr><tr><td valign="top"><a href="#%23xml-inheritance%23-0">'#xml-inheritance#'/0</a></td><td></td></tr></table>


<a name="functions"></a>


<h2>Function Details</h2>
<h2><a name="functions">Function Details</a></h2>


<a name="%23element%23-5"></a>


<h3>'#element#'/5</h3>


Expand All @@ -40,10 +38,8 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla

`#element#(Tag, Data, Attrs, Parents, E) -> any()`


<a name="%23root%23-4"></a>


<h3>'#root#'/4</h3>


Expand All @@ -52,10 +48,8 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla

`#root#(Data, Attrs, X3, E) -> any()`


<a name="%23text%23-1"></a>


<h3>'#text#'/1</h3>


Expand All @@ -64,10 +58,8 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla

`#text#(Text) -> any()`


<a name="%23xml-inheritance%23-0"></a>


<h3>'#xml-inheritance#'/0</h3>


Expand All @@ -78,4 +70,4 @@ __Authors:__ Ulf Wiger ([`[email protected]`](mailto:ulf.wiger@erla



_Generated by EDoc, Mar 23 2011, 18:36:45._
_Generated by EDoc, Mar 24 2011, 12:34:30._
1 change: 1 addition & 0 deletions rebar.config
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
{clean_files, ["*~","*/*~","ebin/*.beam"]}.
{edoc_opts, [{doclet, edown_doclet},
{src_path, ["src", "test"]},
{app_default,"http://www.erlang.org/doc/man"}]}.
5 changes: 5 additions & 0 deletions src/edown_doclet.erl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,11 @@
%% INHERIT-OPTIONS: stylesheet/1

run(#doclet_gen{}=Cmd, Ctxt) ->
%% dbg:tracer(),
%% dbg:tpl(?MODULE,x),
%% dbg:tpl(edown_layout,x),
%% dbg:tpl(edown_xmerl, x),
%% dbg:p(all,[c]),
gen(Cmd#doclet_gen.sources,
Cmd#doclet_gen.app,
Cmd#doclet_gen.packages,
Expand Down
Loading

0 comments on commit 56d4aae

Please sign in to comment.