{"id":21707226,"url":"https://github.com/revathskumar/sublime-yardoc","last_synced_at":"2025-04-12T16:15:05.801Z","repository":{"id":4223384,"uuid":"5345497","full_name":"revathskumar/sublime-yardoc","owner":"revathskumar","description":"SublimeText plugin to generate yardoc","archived":false,"fork":false,"pushed_at":"2017-01-31T20:05:44.000Z","size":39,"stargazers_count":34,"open_issues_count":1,"forks_count":12,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-12T16:14:44.454Z","etag":null,"topics":["ruby","sublime-text","yardoc"],"latest_commit_sha":null,"homepage":"http://revathskumar.github.com/sublime-yardoc/","language":"Python","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/revathskumar.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":"2012-08-08T18:11:46.000Z","updated_at":"2021-06-03T18:47:08.000Z","dependencies_parsed_at":"2022-09-21T00:21:34.632Z","dependency_job_id":null,"html_url":"https://github.com/revathskumar/sublime-yardoc","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revathskumar%2Fsublime-yardoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revathskumar%2Fsublime-yardoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revathskumar%2Fsublime-yardoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revathskumar%2Fsublime-yardoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revathskumar","download_url":"https://codeload.github.com/revathskumar/sublime-yardoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248594190,"owners_count":21130316,"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":["ruby","sublime-text","yardoc"],"created_at":"2024-11-25T22:16:18.102Z","updated_at":"2025-04-12T16:15:05.775Z","avatar_url":"https://github.com/revathskumar.png","language":"Python","readme":"## SublimeText package for generating Yardoc\n\n### Installation\n\n### With Package Control\nThe easiest way to install this is with [Package Control](http://wbond.net/sublime\\_packages/package\\_control).\n\n   * If you just went and installed Package Control, you probably need to restart Sublime Text 2    before doing this next bit.\n   * Bring up the Command Palette (Command+Shift+p on OS X, Control+Shift+p on Linux/Windows).\n   * Select \"Package Control: Install Package\" (it'll take a few seconds)\n   * Select Yardoc when the list appears.\n\nPackage Control will automatically keep Yardoc up to date with the latest version.\n\n### Without Package Control\n\nGo to your Sublime Text 2 **Packages** directory and clone the repository using the command below:\n\n    git clone git@github.com:revathskumar/sublime-yardoc.git yardoc\n\nDon't forget to keep updating it, though!\n\n### Usage\n\nPressing **ctrl+enter** on the line of the method definition\n```ruby\ndef hello a, b\n\nend\n```\n\nresults\n\n```ruby\n#\n# [hello description]\n# @param a [type] [description]\n# @param b [type] [description]\n#\n# @return [type] [description]\ndef hello a, b\n\nend\n```\n\n![Method yardoc](https://lh6.googleusercontent.com/-C9V-e0vzDq0/UERyoS0I4oI/AAAAAAAAG48/M2cptkMfmgA/s458/123.gif)\n\nPressing **ctrl+enter** on the line of the class definition\n\n```ruby\nclass Hello\n\nend\n```\n\nresults\n\n```ruby\n#\n# [class description]\n#\n# @author\n#\nclass Hello\n\nend\n```\n\n### Settings\n\nTwo settings are available:\n\n```json\n    // Determines if empty comment lines have a trailing space\n    \"trailing_spaces\": false,\n    // Add an initial empty line at the beginning of the comment\n    \"initial_empty_line\": false\n```\n\n### License\n\n```\nThe MIT License (MIT)\nCopyright (c) 2013 Revath S Kumar\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in the\nSoftware without restriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell copies of the\nSoftware, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN\nAN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevathskumar%2Fsublime-yardoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevathskumar%2Fsublime-yardoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevathskumar%2Fsublime-yardoc/lists"}