<commit_before>phpdox
======

*PHPDox* is an alternative projet to PHPDocumentor.


Requirements
------------

You need to make sure you're using PHP 5.3+.

Also, you'll need to install the following pear dependencies:
    /var/www $ sudo pear channel-discover pear.netpirates.net
    /var/www $ sudo pear install theseer/DirectoryScanner
    /var/www $ sudo pear install theseer/fDOMDocument
    /var/www $ sudo pear install theseer/fXSL

Finally, you'll need the ezcConsoleTools from components.ez.no:
    /var/www $ sudo pear channel-discover components.ez.no
    /var/www $ sudo pear install ezc/ConsoleTools 


Installation
------------

Make sure you've installed all the requirements.

Get the source code from GIT:
    ~ $ cd /var/www/
    /var/www/ $ git clone --recursive <EMAIL>:Username/phpdox.git

_Note: If you've forgot the --recursive argument, you'll not have the staticReflection submodule in lib/. So you might want to use:_
    /var/www/ $ git submodule init
    /var/www/ $ git submodule update


Usage Examples
--------------

You can run phpdox like this:
    /var/www/ $ phpdox/phpdox.php


trouble shooting
----------------

* If you run phpdox.php and get the following error:<commit_msg>Made the Install guide copy/pasteable<commit_after>phpdox
======

*PHPDox* is an alternative projet to PHPDocumentor.


Requirements
------------

You need to make sure you're using PHP 5.3+.

Also, you'll need to install the following pear dependencies:
    sudo pear channel-discover pear.netpirates.net
    sudo pear install theseer/DirectoryScanner
    sudo pear install theseer/fDOMDocument
    sudo pear install theseer/fXSL

Finally, you'll need the ezcConsoleTools from components.ez.no:
    sudo pear channel-discover components.ez.no
    sudo pear install ezc/ConsoleTools 


Installation
------------

Make sure you've installed all the requirements.

Get the source code from GIT:
    git clone --recursive <EMAIL>:Username/phpdox.git

_Note: If you've forgot the --recursive argument, you'll not have the staticReflection submodule in lib/. So you might want to use:_
    git submodule init
    git submodule update


Usage Examples
--------------

You can run phpdox like this:
    phpdox/phpdox.php


trouble shooting
----------------

* If you run phpdox.php and get the following error:
{'fraction_non_alphanumeric': 0.1148036253776435, 'fraction_numerical': 0.0017263703064307294, 'mean_word_length': 2.895798319327731, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 11, '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': '2680597', 'n_tokens_mistral': 722, 'n_tokens_neox': 669, 'n_words': 261}