phpdox

Command line documentation tool for PHP. Get info of any PHP function on your terminal using it.

###Installation

• Clone the github repository git clone https://github.com/ds406/phpdox.git
• Navigate to the cloned repository. cd phpdox
• Type bash install.sh
• Run the application by phpdox function_name

###Usage

To know about a particular function, run phpdox function_name

###Dependencies

php-cli and php are required to be installed

###Important Features in next release

• Language reference
• Documentation for security and special features
• Option to choose to view examples of functions
• Hacker's guide (documentation about writing classes, modifying ini settings, pdo, memory managment, etc.)
• Option to update documentation
• View documentation from online sources

###Contributors

• Deepak Sharma
• Shivam Dixit
• Aayush Kumar

Note: This tool is currently in alpha version. More features coming soon.