codeeshop-oc/document-php

DocumentPHP is a PHP Helper Package for preparing Documentation

Maintainers

Details

github.com/codeeshop-oc/document-php

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 1

0.0.2 2022-02-08 12:49 UTC

Requires

  • php: >=5.4.0

Requires (Dev)

MIT 4a69ef4a84d6a1202a3c5348f9f32b6bb03d4b5b

documentationopencartDocumentPHPDocument PHPPHP DocumentPHP DocumentorOpencart Documentation

This package is not auto-updated.

Last update: 2024-05-15 23:29:29 UTC

README

License: 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 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:

Screenshots

til