{"id":37232644,"url":"https://github.com/qaharmdz/doctracer","last_synced_at":"2026-01-15T03:50:11.186Z","repository":{"id":62531452,"uuid":"388147269","full_name":"qaharmdz/doctracer","owner":"qaharmdz","description":"DocTracer helps you to create meaningful API documentation reports. Reflecting PHP class information and show markdown formatted documentation on one page.","archived":false,"fork":false,"pushed_at":"2022-10-04T15:00:55.000Z","size":234,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-01T03:53:30.102Z","etag":null,"topics":["docblocks","php"],"latest_commit_sha":null,"homepage":"https://qaharmdz.github.io/doctracer/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qaharmdz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-07-21T14:40:31.000Z","updated_at":"2021-12-30T01:34:13.000Z","dependencies_parsed_at":"2022-11-02T14:45:37.335Z","dependency_job_id":null,"html_url":"https://github.com/qaharmdz/doctracer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/qaharmdz/doctracer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qaharmdz%2Fdoctracer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qaharmdz%2Fdoctracer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qaharmdz%2Fdoctracer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qaharmdz%2Fdoctracer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qaharmdz","download_url":"https://codeload.github.com/qaharmdz/doctracer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qaharmdz%2Fdoctracer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28419246,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T10:47:48.104Z","status":"ssl_error","status_checked_at":"2026-01-14T10:46:19.031Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docblocks","php"],"created_at":"2026-01-15T03:50:10.617Z","updated_at":"2026-01-15T03:50:11.172Z","avatar_url":"https://github.com/qaharmdz.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"DocTracer\n==================\n\nDocTracer helps you to create meaningful API documentation reports. \nReflecting PHP class information and show markdown formatted documentation on one page.\n\nVisit DocTracer [API Documentation](https://qaharmdz.github.io/doctracer/doctracer-api.html) to see the results.\n\n![DocTracer preview](https://qaharmdz.github.io/doctracer/images/doctracer-theme-darkmoon-s.png)\n\nInstallation\n------------\n\n```bash\ncomposer require qaharmdz/doctracer --dev\n```\n\nUsage\n-----\n\nCreate the DocTracer instance.\n\n```php\n$tracer = new \\Mdz\\DocTracer($baseDirectory = './');\n```\n\nInspect all PHP codes inside target directory (relative to the `$baseDir`).\n\n```php\n$tracer-\u003einspect('./../src');\n$tracer-\u003einspect('./Library/');\n```\n\n### Inspection Results\n\nGet the inspection results data.\n\n```php\n$reports = $tracer-\u003egetResults();\nvar_dump($reports);\n```\n\n### HTML Report\n\nOutput the HTML report.\n\n```php\necho $output = $tracer-\u003erender([\n    'title'   =\u003e 'DocTracer Test',\n    'tagline' =\u003e 'PHP ReflectionClass and API documentation',\n    'theme'   =\u003e 'darkmoon',\n]);\n```\n\nSave the output to file.\n\n```php\nfile_put_contents('example-api.html', $output);\n```\n\n\n**Render options**\n\n- `title`      Page heading (h1) and meta title\n- `tagline`    Page heading tagline\n- `footer`     Footer information. _Default_: `{title} - {tagline}`\n- `theme`      Report theme. _Options_: `default`, `darkmoon`\n- `css`        Customize the report style\n- `template`   Custom template path\n\n### License (MIT)\n\n*Copyright (c) 2021 Mudzakkir.*\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqaharmdz%2Fdoctracer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqaharmdz%2Fdoctracer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqaharmdz%2Fdoctracer/lists"}