{"id":19028849,"url":"https://github.com/phingofficial/task-apigen","last_synced_at":"2025-04-23T15:47:19.212Z","repository":{"id":57038918,"uuid":"230990483","full_name":"phingofficial/task-apigen","owner":"phingofficial","description":"[READ-ONLY] Task for ApiGen, a tool for creating professional API documentation from PHP source code","archived":false,"fork":false,"pushed_at":"2024-12-04T19:52:13.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T18:18:28.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phingofficial.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-30T22:53:03.000Z","updated_at":"2023-04-04T08:26:06.000Z","dependencies_parsed_at":"2024-11-08T21:12:34.149Z","dependency_job_id":"35e71489-18f7-4e24-963c-7e3ac37b00a5","html_url":"https://github.com/phingofficial/task-apigen","commit_stats":{"total_commits":7,"total_committers":3,"mean_commits":"2.3333333333333335","dds":0.5714285714285714,"last_synced_commit":"df34b0d85ae681335d1911b5ebab0a6653e59946"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phingofficial%2Ftask-apigen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phingofficial%2Ftask-apigen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phingofficial%2Ftask-apigen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phingofficial%2Ftask-apigen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phingofficial","download_url":"https://codeload.github.com/phingofficial/task-apigen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250463878,"owners_count":21434880,"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":[],"created_at":"2024-11-08T21:12:28.917Z","updated_at":"2025-04-23T15:47:19.192Z","avatar_url":"https://github.com/phingofficial.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [READ-ONLY] task-apigen\n\nTask for ApiGen, a tool for creating professional API documentation from PHP source code.\n\nThis is a read-only split of https://github.com/phingofficial/phing/tree/main/src/Phing/Task/Ext/ApiGen.\n\nPlease [report issues](https://github.com/phingofficial/phing/issues) and\n[send Pull Requests](https://github.com/phingofficial/phing/pulls)\nin the [main Phing repository](https://github.com/phingofficial/phing).\n\n## Attributes\n\n| Name | Type | Description | Default | Required |\n|---|---|---|---|---|\n| executable | String  | ApiGen executable name.  | apigen  | No  |\n| action | String | ApiGen action to be executed. | generate | No |\n| config | String | Config file name. | n/a | Source and destination are required - either set explicitly or using a config file. Attribute values set explicitly have precedence over values from a config file. |\n| source | String | List of source files or directories. | n/a |\n| destination | String | Destination directory. | n/a |\n| exclude | String | List of masks (case sensitive) to exclude files or directories from processing. | n/a | No |\n| skipdocpath | String | List of masks (case sensitive) to exclude elements from documentation generating. | n/a | No |\n| charset | String | Character set of source files. | UTF-8 | No |\n| main | String | Main project name prefix. | n/a | No |\n| title | String | Title of generated documentation. | n/a | No |\n| baseurl | String | Documentation base URL. | n/a | No |\n| googlecseid | String | Google Custom Search ID. | n/a | No |\n| googlecselabel | String | Google Custom Search label. | n/a | No |\n| googleanalytics | String | Google Analytics tracking code. | n/a | No |\n| templateconfig | String | Template config file name. | n/a | If not set the default template is used. |\n| templatetheme | String | Template theme file name. | n/a | If not set the default template is used. |\n| accesslevels | String | Element access levels. Documentation only for methods and properties with the given access level will be generated. | public, protected | No |\n| internal | Boolean | Whether to generate documentation for elements marked as internal and internal documentation parts or not. | No | No |\n| php | Boolean | Whether to generate documentation for PHP internal classes or not. | Yes | No |\n| tree | Boolean | Whether to generate tree view of classes, interfaces, traits and exceptions or not. | Yes | No |\n| deprecated | Boolean | Whether to generate documentation for deprecated elements or not. | No | No |\n| todo | Boolean | Whether to generate documentation of tasks or not. | No | No |\n| sourcecode | Boolean | Whether to generate highlighted source code files or not. | Yes | No |\n| download | Boolean | Whether to generate a link to download documentation as a ZIP archive or not. | No | No |\n| debug | Boolean | Whether to enable the debug mode or not. | No | No\n\n## Example\n```xml\n\u003capigen\n  source=\"classes\"\n  destination=\"api\"\n  exclude=\"*/tests/*\"\n  title=\"My Project API Documentation\"\n  deprecated=\"true\"\n  todo=\"true\"/\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphingofficial%2Ftask-apigen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphingofficial%2Ftask-apigen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphingofficial%2Ftask-apigen/lists"}