{"id":17047082,"url":"https://github.com/dimitarpetrov/godoc-generate","last_synced_at":"2025-07-27T20:04:50.323Z","repository":{"id":46820329,"uuid":"403979894","full_name":"DimitarPetrov/godoc-generate","owner":"DimitarPetrov","description":"Default godoc generator - make your first steps towards better code documentation","archived":false,"fork":false,"pushed_at":"2021-09-23T15:33:28.000Z","size":22,"stargazers_count":21,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T16:00:07.995Z","etag":null,"topics":["code-comments","code-quality","documentation","documentation-generator","generator","go","godoc","golang"],"latest_commit_sha":null,"homepage":"","language":"Go","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/DimitarPetrov.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":"2021-09-07T13:01:12.000Z","updated_at":"2024-12-10T21:18:20.000Z","dependencies_parsed_at":"2022-09-16T01:25:04.478Z","dependency_job_id":null,"html_url":"https://github.com/DimitarPetrov/godoc-generate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DimitarPetrov/godoc-generate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DimitarPetrov%2Fgodoc-generate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DimitarPetrov%2Fgodoc-generate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DimitarPetrov%2Fgodoc-generate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DimitarPetrov%2Fgodoc-generate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DimitarPetrov","download_url":"https://codeload.github.com/DimitarPetrov/godoc-generate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DimitarPetrov%2Fgodoc-generate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267417664,"owners_count":24083839,"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","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["code-comments","code-quality","documentation","documentation-generator","generator","go","godoc","golang"],"created_at":"2024-10-14T09:48:22.112Z","updated_at":"2025-07-27T20:04:50.306Z","avatar_url":"https://github.com/DimitarPetrov.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# godoc-generate\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/DimitarPetrov/godoc-generate)](https://goreportcard.com/report/github.com/DimitarPetrov/godoc-generate)\n\n## Overview\n\n`godoc-generate` is a simple command line tool that generates default godoc comments on all **exported** `types`, `functions`, `consts` and `vars` in the current working directory and recursively for all subdirectories.\n\nThe godoc comments looks like this:\n\n```\n// %s missing godoc.\n```\n\nWhere `%s` is the name of the type/func/const/var.\n\n\u003e NOTE: The comment format can be overridden via the `--format` flag.\n\n## Installation\n\n#### Installing from Source\n```\ngo install github.com/DimitarPetrov/godoc-generate@latest\n```\n\n## Demonstration\n\nLet's say you have a simple `Multiply` function without `godoc`:\n\n```go\nfunc Multiply(a,b int) int {\n\treturn a * b\n}\n```\n\nIt is exported, therefore it is part of the package's interface. It is ideomatic to add godoc on everything exported in your package.\n\nIf you run `godoc-genenrate` the code will be rewritten the following way:\n\n```go\n// Multiply missing godoc.\nfunc Multiply(a, b int) int {\n\treturn a * b\n}\n```\n\nThis way you are safe to add a linter enforcing godoc and migrate all legacy code gradually.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimitarpetrov%2Fgodoc-generate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdimitarpetrov%2Fgodoc-generate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimitarpetrov%2Fgodoc-generate/lists"}