{"id":16107820,"url":"https://github.com/saik0s/swiftdocautomator","last_synced_at":"2025-03-18T08:32:28.846Z","repository":{"id":235693528,"uuid":"635103136","full_name":"Saik0s/SwiftDocAutomator","owner":"Saik0s","description":"SwiftDocAutomator is an AI-powered tool that streamlines the generation of clear and concise documentation comments for Swift code, following Apple and Swift best practices.","archived":false,"fork":false,"pushed_at":"2023-05-02T02:07:37.000Z","size":417,"stargazers_count":14,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T16:45:27.013Z","etag":null,"topics":["ai","documentation","gpt-4","langchain","openai","python","swift","tree-sitter"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Saik0s.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-05-02T01:14:11.000Z","updated_at":"2024-12-10T14:10:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"b9bb9b70-9c92-466e-a27f-1b8078825ab5","html_url":"https://github.com/Saik0s/SwiftDocAutomator","commit_stats":null,"previous_names":["saik0s/swiftdocautomator"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saik0s%2FSwiftDocAutomator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saik0s%2FSwiftDocAutomator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saik0s%2FSwiftDocAutomator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saik0s%2FSwiftDocAutomator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Saik0s","download_url":"https://codeload.github.com/Saik0s/SwiftDocAutomator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244184344,"owners_count":20412198,"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":["ai","documentation","gpt-4","langchain","openai","python","swift","tree-sitter"],"created_at":"2024-10-09T19:24:33.801Z","updated_at":"2025-03-18T08:32:28.841Z","avatar_url":"https://github.com/Saik0s.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SwiftDocAutomator\n\nSwiftDocAutomator is a powerful tool that automatically generates documentation comments for your Swift code, following the official Apple and Swift guidelines. It helps you save time and effort by analyzing your code and producing concise, easy-to-understand documentation.\n\n## Features\n\n- Automatically generates documentation comments for Swift functions and properties\n- Follows the official Apple and Swift guidelines for documentation\n- Supports class and function summaries\n- Easy to integrate into your existing workflow\n\n## Installation\n\nTo install SwiftDocAutomator, simply clone the repository and install the required dependencies:\n\n```bash\ngit clone https://github.com/Saik0s/SwiftDocAutomator.git\ncd SwiftDocAutomator\npip install -r requirements.txt\n```\n\n## Usage\n\nTo use SwiftDocAutomator, run the following command:\n\n```bash\npython main.py /path/to/your/swift/file.swift\n```\n\nThis will generate documentation comments for all functions and properties in the specified Swift file, following the official Apple and Swift guidelines.\n\n## Example\n\nSuppose you have the following Swift function:\n\n```swift\ninternal static func _typeMismatch(at path: [CodingKey], expectation: Any.Type, reality: Any) -\u003e DecodingError {\n    let description = \"Expected to decode \\(expectation) but found \\(_typeDescription(of: reality)) instead.\"\n    return .typeMismatch(expectation, Context(codingPath: path, debugDescription: description))\n}\n```\n\nSwiftDocAutomator will generate the following documentation comment:\n\n```swift\n/// Returns a `.typeMismatch` error describing the expected type.\n///\n/// - parameter path: The path of `CodingKey`s taken to decode a value of this type.\n/// - parameter expectation: The type expected to be encountered.\n/// - parameter reality: The value that was encountered instead of the expected type.\n/// - returns: A `DecodingError` with the appropriate path and debug description.\n```\n\n## Contributing\n\nI'm happy to receive any contributions you may have. If you have any suggestions, bug reports, or feature requests, please feel free to open an issue on the GitHub repository. Your feedback is valuable to me and I appreciate any input you can provide.\n\n## License\n\nSwiftDocAutomator is released under the MIT License. See the LICENSE file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaik0s%2Fswiftdocautomator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaik0s%2Fswiftdocautomator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaik0s%2Fswiftdocautomator/lists"}