├── .gitignore
├── Makefile
├── README.markdown
├── erldocs
├── priv
├── bin
│ └── specs_gen.escript
└── www
│ └── index.html
├── rebar
├── rebar.config
├── src
├── erldocs.app.src
├── erldocs.erl
└── erldocs_core.erl
└── templates
├── erldocs.dtl
├── erldocs_css.dtl
├── erldocs_js.dtl
└── jquery_js.dtl
/.gitignore:
--------------------------------------------------------------------------------
1 | .eunit
2 | deps
3 | *.o
4 | *.beam
5 | ebin
6 | priv/www
7 | !/priv/www/index.html
8 | /.settings
9 | /.project
10 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | .PHONY: deps
2 |
3 | all:
4 | ./rebar compile escriptize
5 |
6 | deps:
7 | ./rebar get-deps
8 |
9 | clean:
10 | @./rebar clean
11 |
12 | distclean: clean
13 | @rm -rf erldocs deps
14 |
--------------------------------------------------------------------------------
/README.markdown:
--------------------------------------------------------------------------------
1 | **NOTE: the actively used & supported version of erldocs is at https://github.com/erldocs/erldocs**
2 |
3 | Erldocs
4 | =======
5 |
6 | This is the code used to generate documentation for erlang projects in the format of [erldocs.com](http://erldocs.com)
7 |
8 | Dependencies
9 | ============
10 |
11 | Erlang R13B04 or greater
12 |
13 | Building
14 | ========
15 |
16 | git clone git://github.com/daleharvey/erldocs.git
17 | cd erldocs
18 | ./rebar get-deps
19 | make
20 |
21 | or download [https://github.com/daleharvey/erldocs/raw/master/erldocs](https://github.com/daleharvey/erldocs/raw/master/erldocs) and place it in your $PATH
22 |
23 | Usage
24 | =====
25 |
26 | Calling the erldocs script with no arguments will generate documentation for the application in the current working directory. The documentation will be output to "doc/erldocs".
27 |
28 | `./erldocs`
29 |
30 | Additional arguments can specify the location to source files to be documented
31 |
32 | `./erldocs path/to/erlang/otp/lib/* path/to/erlang/erts`
33 |
34 | You can specify the output directory with the `-o` flag
35 |
36 | `./erldocs -o path/to/output path/to/erlang/otp/lib/* path/to/erlang/erts`
37 |
--------------------------------------------------------------------------------
/erldocs:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/daleharvey/erldocs/9a82b0b8ec1736a91f2936b01c5b573a63286770/erldocs
--------------------------------------------------------------------------------
/priv/bin/specs_gen.escript:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env escript
2 | %% -*- erlang -*-
3 | %% %CopyrightBegin%
4 | %%
5 | %% Copyright Ericsson AB 2011. All Rights Reserved.
6 | %%
7 | %% The contents of this file are subject to the Erlang Public License,
8 | %% Version 1.1, (the "License"); you may not use this file except in
9 | %% compliance with the License. You should have received a copy of the
10 | %% Erlang Public License along with this software. If not, it can be
11 | %% retrieved online at http://www.erlang.org/.
12 | %%
13 | %% Software distributed under the License is distributed on an "AS IS"
14 | %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
15 | %% the License for the specific language governing rights and limitations
16 | %% under the License.
17 | %%
18 | %% %CopyrightEnd%
19 |
20 | %%%
107 |
108 |
109 |
110 |
111 |
125 |
126 |