{"id":22981039,"url":"https://github.com/rubyworks/yard-bird","last_synced_at":"2025-08-13T17:33:52.190Z","repository":{"id":1496135,"uuid":"1748282","full_name":"rubyworks/yard-bird","owner":"rubyworks","description":"Custom YARD Documentation","archived":false,"fork":false,"pushed_at":"2011-11-12T04:48:52.000Z","size":294,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-30T10:19:57.012Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://rubyworks.github.com/yard-bird","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/rubyworks.png","metadata":{"files":{"readme":"README.rdoc","changelog":"HISTORY.rdoc","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-05-14T17:05:25.000Z","updated_at":"2021-08-21T21:27:57.000Z","dependencies_parsed_at":"2022-08-16T13:25:19.789Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/yard-bird","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-bird","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-bird/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-bird/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fyard-bird/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/yard-bird/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229773540,"owners_count":18122031,"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-12-15T01:46:49.547Z","updated_at":"2024-12-15T01:46:49.988Z","avatar_url":"https://github.com/rubyworks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Yard Bird\n\n\u003ci\u003e\"Sing sweet documentation in my ear.\"\u003c/i\u003e\n\n\n== Description\n\nYardbird is a YARD plugin that allows you, the developer, to customize your\ndocumentation parsing system.\n\n\n== Resources\n\n* {Homepage}[http://rubyworks.github.com]\n* {Source Code}[http://github.com/rubyworks]\n* {Mainling List}[http://groups.google.com/group/rubyworks-mailinglist]\n* {\u003cimg src=\"http://travis-ci.org/rubyworks/yard-bird.png\" /\u003e}[http://travis-ci.org/rubyworks/yard-bird]\n\n\n== Check It Out\n\nSound like a chore? Until you see it allows you do this:\n\n  # .yard/example.bird\n\n  When /^Returns\\s+(.*?)$/ do |matchdata, comment|\n    create_tag(:return, matchdata[1])\n  end\n\nNow, whenever your documentation starts with 'Returns ', the\nremainder of the line will be added to YARD as a :return tag.\n\nNow we can get even crazier a create a simplified implementation of {Tomdoc}[http://tomdoc].\n\n  require 'tomdoc/tomdoc'\n\n  When /\\A.*?\\Z/m do |matchdata, comment|\n    tomdoc = TomDoc::TomDoc.new(comment)\n    tomdoc.examples.each {|ex| create_tag(:example, \"\\n\" + ex) }\n    tomdoc.args.each {|arg| create_tag(:param, \"#{arg.name} #{arg.description}\") }\n    tomdoc.raises.each {|r| create_tag(:raise, r.sub(/\\ARaises\\s+/, '')) }\n    tomdoc.returns.each {|r| create_tag(:return, r.sub(/\\AReturns\\s+/, '')) }\n    tomdoc.description\n  end\n\nNow it's your turn. You have the _power_*, Yard Bird will singe _Your_ song.\nAnd YARD will happily spit it out all pretty.\n\n\n== License\n\n(MIT License)\n\nCopyright (c) 2011 Rubyworks\n\nSee NOTICE.rdoc file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fyard-bird","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Fyard-bird","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fyard-bird/lists"}