{"id":16839176,"url":"https://github.com/cyqsimon/documented","last_synced_at":"2025-04-06T07:12:54.833Z","repository":{"id":172780093,"uuid":"649739025","full_name":"cyqsimon/documented","owner":"cyqsimon","description":"Macros for accessing your type's documentation at runtime.","archived":false,"fork":false,"pushed_at":"2024-10-29T05:49:22.000Z","size":248,"stargazers_count":26,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-30T10:20:43.465Z","etag":null,"topics":["derive-macro","documentation","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/cyqsimon.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-05T14:25:13.000Z","updated_at":"2024-10-29T05:49:23.000Z","dependencies_parsed_at":"2024-02-03T12:25:50.794Z","dependency_job_id":"6190d905-c36a-4d6f-ba17-e3b3bbc62db7","html_url":"https://github.com/cyqsimon/documented","commit_stats":{"total_commits":113,"total_committers":3,"mean_commits":"37.666666666666664","dds":0.06194690265486724,"last_synced_commit":"1ab4d0bd9198daf5a5d2aeb26054ba1de73d569b"},"previous_names":["cyqsimon/documented"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyqsimon%2Fdocumented","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyqsimon%2Fdocumented/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyqsimon%2Fdocumented/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyqsimon%2Fdocumented/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyqsimon","download_url":"https://codeload.github.com/cyqsimon/documented/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247445671,"owners_count":20939958,"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":["derive-macro","documentation","rust"],"created_at":"2024-10-13T12:29:48.269Z","updated_at":"2025-04-06T07:12:54.816Z","avatar_url":"https://github.com/cyqsimon.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# documented\n\nDerive and attribute macros for accessing your type's documentation at runtime\n\n- [crates.io](https://crates.io/crates/documented)\n- [docs.rs](https://docs.rs/documented/latest/documented/)\n\n## Quick start\n\n```rust\nuse documented::{Documented, DocumentedFields, DocumentedVariants};\n\n/// Trying is the first step to failure.\n#[derive(Documented, DocumentedFields, DocumentedVariants)]\nenum AlwaysPlay {\n    /// And Kb8.\n    #[allow(dead_code)]\n    Kb1,\n    /// But only if you are white.\n    F6,\n}\n\n// Documented\nassert_eq!(AlwaysPlay::DOCS, \"Trying is the first step to failure.\");\n\n// DocumentedFields\nassert_eq!(\n    AlwaysPlay::FIELD_DOCS,\n    [\"And Kb8.\", \"But only if you are white.\"]\n);\nassert_eq!(AlwaysPlay::get_field_docs(\"Kb1\"), Ok(\"And Kb8.\"));\n\n// DocumentedVariants\nassert_eq!(\n    AlwaysPlay::F6.get_variant_docs(),\n    \"But only if you are white.\"\n);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyqsimon%2Fdocumented","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyqsimon%2Fdocumented","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyqsimon%2Fdocumented/lists"}