Skip to content
This repository has been archived by the owner on Dec 9, 2022. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
removed dependency on edoc_doclet.hrl
  • Loading branch information
Ulf Wiger committed Oct 22, 2010
1 parent 1fbc3ba commit e985404
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 41 deletions.
34 changes: 1 addition & 33 deletions doc/edown_doclet.md
Expand Up @@ -4,7 +4,6 @@ Module edown_doclet

#Module edown_doclet#
* [Description](#description)
* [Data Types](#types)
* [Function Index](#index)
* [Function Details](#functions)
EDoc Doclet module for producing Github-flavored Markdown.
Expand All @@ -14,37 +13,6 @@ __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erla
##<a name="description">Description</a>##
EDoc Doclet module for producing Github-flavored Markdown.

##<a name="types">Data Types</a>##

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


###doclet_gen()##

`doclet_gen() = #doclet_gen{sources = [string()], app = [no_app()](#type-no_app) | atom(), packages = [atom()], modules = [atom()], modules = [atom()], filemap = function()}`
<a name="type-doclet_toc"></a>


###doclet_toc()##

`doclet_toc() = #doclet_gen{paths = [string()], indir = string()}`
<a name="type-edoc_context"></a>


###edoc_context()##

`edoc_context() = #context{dir = string(), env = [edoc_lib:edoc_env()](edoc_lib.html#type-edoc_env), opts = [term()]}`
<a name="type-no_app"></a>


###no_app()##

__abstract datatype__: `no_app()`
A value used to mark absence of an Erlang application
context. Use the macro `NO_APP` defined in
[`edoc_doclet.hrl`](../include/edoc_doclet.hrl)
to produce this value.

##<a name="index">Function Index</a>##

<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>
Expand Down Expand Up @@ -131,4 +99,4 @@ Specifies the name of the stylesheet file. By default, this
Specifies the title of the overview-page.


_Generated by EDoc, Oct 22 2010, 18:46:46._
_Generated by EDoc, Oct 22 2010, 19:30:35._
2 changes: 1 addition & 1 deletion doc/edown_layout.md
Expand Up @@ -106,4 +106,4 @@ __See also:__ [edoc:layout/2](edoc.html#layout-2).

`type(E) -> any()`

_Generated by EDoc, Oct 22 2010, 18:46:46._
_Generated by EDoc, Oct 22 2010, 19:30:35._
2 changes: 1 addition & 1 deletion doc/edown_lib.md
Expand Up @@ -30,4 +30,4 @@ Github-flavored Markdown for EDoc - common support functions

`export(Data) -> any()`

_Generated by EDoc, Oct 22 2010, 18:46:46._
_Generated by EDoc, Oct 22 2010, 19:30:35._
2 changes: 1 addition & 1 deletion doc/edown_xmerl.md
Expand Up @@ -50,4 +50,4 @@ __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erla

`#xml-inheritance#() -> any()`

_Generated by EDoc, Oct 22 2010, 18:46:46._
_Generated by EDoc, Oct 22 2010, 19:30:35._
1 change: 1 addition & 0 deletions rebar.config
Expand Up @@ -7,3 +7,4 @@

{clean_files, ["*~","*/*~","ebin/*.beam"]}.
{edoc_opts, [{doclet, edown_doclet},{include, ""}]}.
5 changes: 0 additions & 5 deletions src/edown_doclet.erl
Expand Up @@ -20,18 +20,13 @@

%% @doc EDoc Doclet module for producing Github-flavored Markdown.

%% TODO: copy "doc-files" subdirectories, recursively.
%% TODO: generate summary page of TODO-notes
%% TODO: generate summary page of deprecated things
%% TODO: generate decent indexes over modules, methods, records, etc.

-module(edown_doclet).

-export([run/2]).

-import(edoc_report, [report/2, warning/2]).

%% @headerfile "edoc_doclet.hrl"
-include_lib("edoc/include/edoc_doclet.hrl").

-define(EDOC_APP, edoc).
Expand Down

0 comments on commit e985404

Please sign in to comment.