{"id":16115242,"url":"https://github.com/pvande/yard-perl-plugin","last_synced_at":"2025-03-18T10:30:28.762Z","repository":{"id":66642814,"uuid":"596724","full_name":"pvande/yard-perl-plugin","owner":"pvande","description":"Developing a Perl documentation tool... in Ruby","archived":false,"fork":false,"pushed_at":"2021-08-13T22:12:21.000Z","size":148,"stargazers_count":11,"open_issues_count":0,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-28T08:45:55.632Z","etag":null,"topics":["documentation-tool","perl"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/pvande.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":"2010-04-06T07:55:23.000Z","updated_at":"2024-10-07T16:46:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"b84875ed-8f30-471e-9eca-b0700cfbb365","html_url":"https://github.com/pvande/yard-perl-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvande%2Fyard-perl-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvande%2Fyard-perl-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvande%2Fyard-perl-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pvande%2Fyard-perl-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pvande","download_url":"https://codeload.github.com/pvande/yard-perl-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243918612,"owners_count":20368745,"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":["documentation-tool","perl"],"created_at":"2024-10-09T20:18:11.090Z","updated_at":"2025-03-18T10:30:28.757Z","avatar_url":"https://github.com/pvande.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"OH SO BETA WARNING\n==================\n\nThis is wildly speculative software.  It works in a few cases.  It breaks in\nall the rest.  USE AT YOUR OWN RISK.  Not valid with any other offer.  Void\nwhere prohibited.\n\nPwa?\n====\n\nHere's what I've been doing:\n\n    $ cd perl-project\n    $ yardoc -e ../yard-perl-plugin/lib/yard-perl-plugin.rb lib/**/*.pm\n\nYARD then transforms my ragtag bunch of (regularly formatted) Perl modules\ninto fine, high-quality documentation.\n\nAt present, this module will:\n\n * Work with YARD 0.6 -- and likely beyond!\n * Parse most Perl!\n   * Support for this is provided by Textpow, via the TextMate Perl.plist\n   (slightly modified)\n * Parse a package declaration\n * Parse a named sub declaration\n * Parse documentation comments\n * Handle subroutine visibility\n   * Subroutines declared before a 'use namespace::clean' are marked private\n   * Subroutines named with a leading '_' are marked protected\n * Handle subroutine parameters\n   * Parameters are inferred from the first few assignments of the subroutine\n   * Assignments that `shift` off @_ will populate a single parameter\n   * Assigning from @_ in list context will further populate parameters\n * Handle method scope\n   * If the first parameter name is 'self' or 'instance', instance scope is\n   assumed\n   * If the first parameter name is 'class' or 'package', class scope is\n   assumed\n   * If the first parameter name is 'receiver', 'invocant', or\n   'class\\_or_self', it is assumed the method may be called as either a class\n   or instance method\n   * If the first parameter name cannot be recognized, instance scope is assumed\n   * **It is recognized that this is sub-optimal; suggestions welcomed**\n * Support the @group tag\n   * This tag applies to all method declarations following, until the next\n   @group tag or a corollary @endgroup tag\n   * Methods in a group are given their own heading in the documentation\n     * This can be used to emulate, for example, a documented export list\n * Provide syntax highlighting for HTML output\n   * Support for this is provided by Textpow, via the TextMate Perl.plist\n   (slightly modified)\n\nThis module *won't*:\n\n * Do much else\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpvande%2Fyard-perl-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpvande%2Fyard-perl-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpvande%2Fyard-perl-plugin/lists"}