<commit_before># Docurium

Docurium is a lightweight Doxygen replacement.  It generates static HTML from the header files of a C project. It is meant to be simple, easy to navigate and git-tag aware. It is only meant to document your public interface, so it only knows about your header files.

I built it to replace the Doxygen generated documentation for the libgit2 project, so I'm only currently testing it against that.  So, it only includes support for features and keywords used in that project currently.

# Usage

Run the `cm` binary and pass it your headers directory.

  $ cm doc includes/
  * generating header based docs
    - processing limit.h
    - processing recess.h
  * output html in docs/

  $ cm doc --branch=gh-pages includes/
  * generating header based docs
    - processing chacon.h
  * output html in gh-pages branch at 3dc12a

# License

MIT, see LICENCE file

<commit_msg>md fix<commit_after># Docurium

Docurium is a lightweight Doxygen replacement.  It generates static HTML from the header files of a C project. It is meant to be simple, easy to navigate and git-tag aware. It is only meant to document your public interface, so it only knows about your header files.

I built it to replace the Doxygen generated documentation for the libgit2 project, so I'm only currently testing it against that.  So, it only includes support for features and keywords used in that project currently.

# Usage

Run the `cm` binary and pass it your headers directory.

    $ cm doc includes/
    * generating header based docs
      - processing limit.h
      - processing recess.h
    * output html in docs/

    $ cm doc --branch=gh-pages includes/
    * generating header based docs
      - processing chacon.h
    * output html in gh-pages branch at 3dc12a

# License

MIT, see LICENCE file


{'fraction_non_alphanumeric': 0.04633204633204633, 'fraction_numerical': 0.00441257584114727, 'mean_word_length': 3.339712918660287, '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': '6898714', 'n_tokens_mistral': 494, 'n_tokens_neox': 464, 'n_words': 265}