Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeeshop-oc/document-php
DocumentPHP is a PHP Helper Package for preparing Documentation
https://github.com/codeeshop-oc/document-php
api api-docs api-docs-generator api-documentation apidocumentations documentation documenting documentor documentphp packagist php
Last synced: about 9 hours ago
JSON representation
DocumentPHP is a PHP Helper Package for preparing Documentation
- Host: GitHub
- URL: https://github.com/codeeshop-oc/document-php
- Owner: codeeshop-oc
- License: mit
- Created: 2022-02-08T10:38:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-08T14:11:05.000Z (almost 3 years ago)
- Last Synced: 2024-04-28T06:44:11.362Z (7 months ago)
- Topics: api, api-docs, api-docs-generator, api-documentation, apidocumentations, documentation, documenting, documentor, documentphp, packagist, php
- Language: PHP
- Homepage: https://packagist.org/packages/codeeshop-oc/document-php
- Size: 812 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
DocumentPHP
=============
What is DocumentPHP?
----------------------
DocumentPHP is an application that is capable of analyzing your PHP source code and fetch the files for making API Documentation Data.
Currently Tested and working with [Opencart](https://www.opencart.com/) Default API's.
DocumentPHP v0.0.2 (Test)
------------------------------------
v0.0.2 is the developmental release.
Features
--------
DocumentPHP supports the following:
* *PHP 5.4+ compatible*
* *Easy to Use*, you can create your Opencart Documentation Easily.
Installation
------------
DocumentPHP requires PHP 5.4 or higher to run.
However, code of earlier PHP versions can be analyzed.
All templates provided with DocumentPHP have support for Class diagrams based on the read code base.
Rendering is done on Classes.
Install DocumentPHP:
### Via Composer
There is a DocumentPHP composer package that you can use to install DocumentPHP.
How to use DocumentPHP ?
-------------------------
To run DocumentPHP after installing via composer and copy the main.php file and make changes accordingly ( file attached in this repo ).
Note- Make Sure the main.php file is at the root location.
Contact
-------
Reaching out to us is easy, and can be done with:
* Twitter: https://twitter.com/codeeshop1
* Twitter 2: https://twitter.com/anantnegik7
* Website: https://www.codeeshop.com
* GitHub: https://github.com/codeeshop-oc/document-php
* E-mail: [email protected]
[Composer]: https://getcomposer.org/
[codeeshop mail]: mailto:[email protected]
Screenshots
-------------------------
