Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcocesarato/php-markdown-docs
This package can convert PHPDoc comments from classes into Markdown. It can parse a class file with a given file name and extracts the documentation of its functions and variables that it may contain in PHPDoc format. The package can convert the extracted documentation into a file in Markdown format.
https://github.com/marcocesarato/php-markdown-docs
class doc documentation format html markdown method pdf php phpdoc type utility
Last synced: 2 months ago
JSON representation
This package can convert PHPDoc comments from classes into Markdown. It can parse a class file with a given file name and extracts the documentation of its functions and variables that it may contain in PHPDoc format. The package can convert the extracted documentation into a file in Markdown format.
- Host: GitHub
- URL: https://github.com/marcocesarato/php-markdown-docs
- Owner: marcocesarato
- License: gpl-3.0
- Created: 2018-07-27T14:02:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-16T13:21:29.000Z (about 2 years ago)
- Last Synced: 2024-11-25T09:16:17.719Z (2 months ago)
- Topics: class, doc, documentation, format, html, markdown, method, pdf, php, phpdoc, type, utility
- Language: PHP
- Homepage:
- Size: 27.3 KB
- Stars: 15
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Class Markdown Documentation
Version: 0.1.11 beta
Github: https://github.com/marcocesarato/PHP-Class-Markdown-Docs
Author: Marco Cesarato
## Description
This package can convert PHPDoc comments from classes into Markdown.
It can parse a class file with a given file name and extracts the documentation of its functions and variables that it may contain in PHPDoc format.
The package can convert the extracted documentation into a file in Markdown format.
## Install
### Composer
1. Install composer
2. Type `composer require marcocesarato/markdown`
4. Enjoy
## Methods
| Method | Description | Type | Parameters | Return |
| ------------- | ---------------------------------- | ------------------- | ---------- | ------ |
| getMarkdown | Get markdown class documentation | public
static | $file | string |
| printMarkdown | Print Markdown class documentation | public
static | $file | |
| getArray | Get php array class documentation | public
static | $file | array |
## Example
### Usage
```php
Markdown::printMarkdown('Sample.php');
```
#### Output Text
```text
## CoreClass
| Method | Description | Type | Parameters | Return |
| ------------- | -------------------------------------------------- | ------ | -------------------------------------------------- | -------------- |
| __construct | Constructor | public | | |
| __init | Initialize | | | bool |
| CoreClass | Constructor | | | |
| getInstance | Get singleton instance | | | CoreClass |
| apply_filters | Apply module hook filters | | $name
$data | mixed |
| do_action | Do module hook actions | | $name | bool |
| add_action | Add module hook action | | $name
$action | bool |
| add_filter | Add module hook filter | | $name
$filter | bool |
| add_request | Add Ajax request | | $name
$request
bool $public | bool |
| exists | Check if element already exists if exists it will be updated on Save else it will be inserted | | null $what
bool $undelete | bool |
| prepare | Prepare retrieve conditions | | null $what
null $operators | array |
| retrieve | Retrieve element | | null $what
bool $encode
null $onlyFields
null $orderBy
bool $returnAsArray
null $operators
bool $dump | array
mixed |
| fetch | | | $what
null $operators | array |
```
#### Markdown Result
## CoreClass
| Method | Description | Type | Parameters | Return |
| ------------- | -------------------------------------------------- | ------ | -------------------------------------------------- | -------------- |
| __construct | Constructor | public | | |
| __init | Initialize | | | bool |
| CoreClass | Constructor | | | |
| getInstance | Get singleton instance | | | CoreClass |
| apply_filters | Apply module hook filters | | $name
$data | mixed |
| do_action | Do module hook actions | | $name | bool |
| add_action | Add module hook action | | $name
$action | bool |
| add_filter | Add module hook filter | | $name
$filter | bool |
| add_request | Add Ajax request | | $name
$request
bool $public | bool |
| exists | Check if element already exists if exists it will be updated on Save else it will be inserted | | null $what
bool $undelete | bool |
| prepare | Prepare retrieve conditions | | null $what
null $operators | array |
| retrieve | Retrieve element | | null $what
bool $encode
null $onlyFields
null $orderBy
bool $returnAsArray
null $operators
bool $dump | array
mixed |
| fetch | | | $what
null $operators | array |