https://github.com/qaharmdz/doctracer
DocTracer helps you to create meaningful API documentation reports. Reflecting PHP class information and show markdown formatted documentation on one page.
https://github.com/qaharmdz/doctracer
docblocks php
Last synced: 5 months ago
JSON representation
DocTracer helps you to create meaningful API documentation reports. Reflecting PHP class information and show markdown formatted documentation on one page.
- Host: GitHub
- URL: https://github.com/qaharmdz/doctracer
- Owner: qaharmdz
- License: mit
- Created: 2021-07-21T14:40:31.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-10-04T15:00:55.000Z (over 3 years ago)
- Last Synced: 2025-09-01T03:53:30.102Z (10 months ago)
- Topics: docblocks, php
- Language: PHP
- Homepage: https://qaharmdz.github.io/doctracer/
- Size: 229 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
DocTracer
==================
DocTracer helps you to create meaningful API documentation reports.
Reflecting PHP class information and show markdown formatted documentation on one page.
Visit DocTracer [API Documentation](https://qaharmdz.github.io/doctracer/doctracer-api.html) to see the results.
Installation
------------
```bash
composer require qaharmdz/doctracer --dev
```
Usage
-----
Create the DocTracer instance.
```php
$tracer = new \Mdz\DocTracer($baseDirectory = './');
```
Inspect all PHP codes inside target directory (relative to the `$baseDir`).
```php
$tracer->inspect('./../src');
$tracer->inspect('./Library/');
```
### Inspection Results
Get the inspection results data.
```php
$reports = $tracer->getResults();
var_dump($reports);
```
### HTML Report
Output the HTML report.
```php
echo $output = $tracer->render([
'title' => 'DocTracer Test',
'tagline' => 'PHP ReflectionClass and API documentation',
'theme' => 'darkmoon',
]);
```
Save the output to file.
```php
file_put_contents('example-api.html', $output);
```
**Render options**
- `title` Page heading (h1) and meta title
- `tagline` Page heading tagline
- `footer` Footer information. _Default_: `{title} - {tagline}`
- `theme` Report theme. _Options_: `default`, `darkmoon`
- `css` Customize the report style
- `template` Custom template path
### License (MIT)
*Copyright (c) 2021 Mudzakkir.*
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.