Ratings | | Unique User Downloads | | Download Rankings |
Not enough user ratings | | Total: 115 | | All time: 9,294 This week: 241 |
|
Description | | Author |
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. Innovation Award
August 2018
Number 3 |
PHPDoc is a popular format for embedding documentation inside class files in the form of comments.
The documentation comments can be parsed and extract in order to generate documentation in different formats.
This package extracts documentation in PHPDoc format and generates human readable documentation in Markdown format, so it can be converted to other richer text formats later, like for instance HTML.
Manuel Lemos |
| |
|
|
Innovation award
Nominee: 2x |
|
Details
PHP Class Markdown Documentation
Version: 0.1.10 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
-
Install composer
-
Type `composer require marcocesarato/markdown`
-
Enjoy
Methods
| Method | Description | Type | Parameters | Return |
| ------------- | ---------------------------------- | ------------------- | ---------- | ------ |
| getMarkdown | Get markdown class documentation | public<br>static | $file | string |
| printMarkdown | Print Markdown class documentation | public<br>static | $file | |
| getArray | Get php array class documentation | public<br>static | $file | array |
Example
Usage
Markdown::printMarkdown('Sample.php');
Output 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<br>$data | mixed |
| do_action | Do module hook actions | | $name | bool |
| add_action | Add module hook action | | $name<br>$action | bool |
| add_filter | Add module hook filter | | $name<br>$filter | bool |
| add_request | Add Ajax request | | $name<br>$request<br>bool $public | bool |
| exists | Check if element already exists if exists it will be updated on Save else it will be inserted | | null $what<br>bool $undelete | bool |
| prepare | Prepare retrieve conditions | | null $what<br>null $operators | array |
| retrieve | Retrieve element | | null $what<br>bool $encode<br>null $onlyFields<br>null $orderBy<br>bool $returnAsArray<br>null $operators<br>bool $dump | array<br>mixed |
| fetch | | | $what<br>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<br>$data | mixed |
| do_action | Do module hook actions | | $name | bool |
| add_action | Add module hook action | | $name<br>$action | bool |
| add_filter | Add module hook filter | | $name<br>$filter | bool |
| add_request | Add Ajax request | | $name<br>$request<br>bool $public | bool |
| exists | Check if element already exists if exists it will be updated on Save else it will be inserted | | null $what<br>bool $undelete | bool |
| prepare | Prepare retrieve conditions | | null $what<br>null $operators | array |
| retrieve | Retrieve element | | null $what<br>bool $encode<br>null $onlyFields<br>null $orderBy<br>bool $returnAsArray<br>null $operators<br>bool $dump | array<br>mixed |
| fetch | | | $what<br>null $operators | array |
|
Applications that use this package |
|
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.