{"id":21700683,"url":"https://github.com/marcocesarato/php-markdown-docs","last_synced_at":"2025-04-12T13:34:40.534Z","repository":{"id":43638922,"uuid":"142584390","full_name":"marcocesarato/PHP-Markdown-Docs","owner":"marcocesarato","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.","archived":false,"fork":false,"pushed_at":"2022-12-16T13:21:29.000Z","size":28,"stargazers_count":15,"open_issues_count":1,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-25T09:16:17.719Z","etag":null,"topics":["class","doc","documentation","format","html","markdown","method","pdf","php","phpdoc","type","utility"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcocesarato.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-27T14:02:34.000Z","updated_at":"2024-10-23T11:59:48.000Z","dependencies_parsed_at":"2023-01-29T14:01:01.179Z","dependency_job_id":null,"html_url":"https://github.com/marcocesarato/PHP-Markdown-Docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2FPHP-Markdown-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2FPHP-Markdown-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2FPHP-Markdown-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcocesarato%2FPHP-Markdown-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcocesarato","download_url":"https://codeload.github.com/marcocesarato/PHP-Markdown-Docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226392982,"owners_count":17617996,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["class","doc","documentation","format","html","markdown","method","pdf","php","phpdoc","type","utility"],"created_at":"2024-11-25T20:15:57.955Z","updated_at":"2024-11-25T20:15:58.590Z","avatar_url":"https://github.com/marcocesarato.png","language":"PHP","readme":"# PHP Class Markdown Documentation\n\nVersion: 0.1.11 beta\n\nGithub: https://github.com/marcocesarato/PHP-Class-Markdown-Docs\n\nAuthor: Marco Cesarato\n\n## Description\n\nThis package can convert PHPDoc comments from classes into Markdown.\n\nIt 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.\n\nThe package can convert the extracted documentation into a file in Markdown format.\n\n## Install\n\n### Composer\n1. Install composer\n2. Type `composer require marcocesarato/markdown`\n4. Enjoy\n\n## Methods\n\n| Method        | Description                        | Type                | Parameters | Return |\n| ------------- | ---------------------------------- | ------------------- | ---------- | ------ |\n| getMarkdown   | Get markdown class documentation   | public\u003cbr\u003estatic    | $file      | string |\n| printMarkdown | Print Markdown class documentation | public\u003cbr\u003estatic    | $file      |        |\n| getArray      | Get php array class documentation  | public\u003cbr\u003estatic    | $file      | array  |\n\n## Example\n\n### Usage\n\n```php\nMarkdown::printMarkdown('Sample.php');\n```\n\n\n#### Output Text\n\n```text\n## CoreClass\n| Method        | Description                                        | Type   | Parameters                                         | Return         |\n| ------------- | -------------------------------------------------- | ------ | -------------------------------------------------- | -------------- |\n| __construct   | Constructor                                        | public |                                                    |                |\n| __init        | Initialize                                         |        |                                                    | bool           |\n| CoreClass     | Constructor                                        |        |                                                    |                |\n| getInstance   | Get singleton instance                             |        |                                                    | CoreClass      |\n| apply_filters | Apply module hook filters                          |        | $name\u003cbr\u003e$data                                     | mixed          |\n| do_action     | Do module hook actions                             |        | $name                                              | bool           |\n| add_action    | Add module hook action                             |        | $name\u003cbr\u003e$action                                   | bool           |\n| add_filter    | Add module hook filter                             |        | $name\u003cbr\u003e$filter                                   | bool           |\n| add_request   | Add Ajax request                                   |        | $name\u003cbr\u003e$request\u003cbr\u003ebool $public                  | bool           |\n| exists        | Check if element already exists if exists it will be updated on Save else it will be inserted |        | null $what\u003cbr\u003ebool $undelete                       | bool           |\n| prepare       | Prepare retrieve conditions                        |        | null $what\u003cbr\u003enull $operators                      | array          |\n| retrieve      | Retrieve element                                   |        | null $what\u003cbr\u003ebool $encode\u003cbr\u003enull $onlyFields\u003cbr\u003enull $orderBy\u003cbr\u003ebool $returnAsArray\u003cbr\u003enull $operators\u003cbr\u003ebool $dump | array\u003cbr\u003emixed |\n| fetch         |                                                    |        | $what\u003cbr\u003enull $operators                           | array          |\n```\n\n#### Markdown Result\n\n## CoreClass\n| Method        | Description                                        | Type   | Parameters                                         | Return         |\n| ------------- | -------------------------------------------------- | ------ | -------------------------------------------------- | -------------- |\n| __construct   | Constructor                                        | public |                                                    |                |\n| __init        | Initialize                                         |        |                                                    | bool           |\n| CoreClass     | Constructor                                        |        |                                                    |                |\n| getInstance   | Get singleton instance                             |        |                                                    | CoreClass      |\n| apply_filters | Apply module hook filters                          |        | $name\u003cbr\u003e$data                                     | mixed          |\n| do_action     | Do module hook actions                             |        | $name                                              | bool           |\n| add_action    | Add module hook action                             |        | $name\u003cbr\u003e$action                                   | bool           |\n| add_filter    | Add module hook filter                             |        | $name\u003cbr\u003e$filter                                   | bool           |\n| add_request   | Add Ajax request                                   |        | $name\u003cbr\u003e$request\u003cbr\u003ebool $public                  | bool           |\n| exists        | Check if element already exists if exists it will be updated on Save else it will be inserted |        | null $what\u003cbr\u003ebool $undelete                       | bool           |\n| prepare       | Prepare retrieve conditions                        |        | null $what\u003cbr\u003enull $operators                      | array          |\n| retrieve      | Retrieve element                                   |        | null $what\u003cbr\u003ebool $encode\u003cbr\u003enull $onlyFields\u003cbr\u003enull $orderBy\u003cbr\u003ebool $returnAsArray\u003cbr\u003enull $operators\u003cbr\u003ebool $dump | array\u003cbr\u003emixed |\n| fetch         |                                                    |        | $what\u003cbr\u003enull $operators                           | array          |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcocesarato%2Fphp-markdown-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcocesarato%2Fphp-markdown-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcocesarato%2Fphp-markdown-docs/lists"}