<commit_before># erldocs
This is the code used to generate documentation for erlang projects in the format of
[erldocs.com](http://erldocs.com)

## Dependencies
Erlang/OTP ≥ R13B04

## Building

    git clone git://github.com/fenollp/erldocs.git
    cd erldocs/
    make

## Usage

    erldocs  [-o ‹output dir›]  [-i ‹include path›]⁺  ‹source path›⁺

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".

    ./erldocs

Additional arguments can specify the location to source files to be documented

    ./erldocs path/to/erlang/otp/lib/* path/to/erlang/erts

You can specify the output directory with the `-o` flag

    ./erldocs -o path/to/output path/to/erlang/otp/lib/* path/to/erlang/erts

Specify paths to include files with `-I ‹path to include file1›`

    ./erldocs -I lib/stdlib/include -I ./include src/

## To Do
* Add include flags in the command-line. (Would allow `-I lib/*/include/*` and fix some erldocs.com 404s)<commit_msg>Finish README<commit_after># erldocs
This is the code used to generate documentation for erlang projects in the format of
[erldocs.com](http://erldocs.com)

## Dependencies
Erlang/OTP ≥ R13B04

## Building

    git clone git://github.com/fenollp/erldocs.git
    cd erldocs/
    make

## Usage *Mind the space around the flags!*

    erldocs  [-o ‹output dir›]  [-I ‹include path›]⁺  ‹source path›⁺

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".

    ./erldocs

Additional arguments can specify the location to source files to be documented

    ./erldocs path/to/erlang/otp/lib/* path/to/erlang/erts

You can specify the output directory with the `-o` flag

    ./erldocs -o path/to/output path/to/erlang/otp/lib/* path/to/erlang/erts

Specify paths to include files with `-I ‹path to include file1›`

    ./erldocs -I lib/stdlib/include -I ./include src/
{'fraction_non_alphanumeric': 0.09878345498783454, 'fraction_numerical': 0.006326034063260341, 'mean_word_length': 3.421505376344086, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2667427', 'n_tokens_mistral': 714, 'n_tokens_neox': 667, 'n_words': 247}