{"id":16647139,"url":"https://github.com/michaelrsweet/codedoc","last_synced_at":"2025-03-21T16:31:00.403Z","repository":{"id":56304348,"uuid":"163907531","full_name":"michaelrsweet/codedoc","owner":"michaelrsweet","description":"Documentation generator for C/C++ code","archived":false,"fork":false,"pushed_at":"2025-01-24T19:40:28.000Z","size":1197,"stargazers_count":51,"open_issues_count":3,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-18T03:01:45.864Z","etag":null,"topics":["code","documentation","epub","html","man"],"latest_commit_sha":null,"homepage":"https://www.msweet.org/codedoc","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaelrsweet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"michaelrsweet","liberapay":"michaelrsweet"}},"created_at":"2019-01-03T01:22:03.000Z","updated_at":"2025-01-24T19:40:32.000Z","dependencies_parsed_at":"2024-10-28T11:26:20.766Z","dependency_job_id":"9bbcda96-8791-4280-ac8c-ff8f5b0a48e6","html_url":"https://github.com/michaelrsweet/codedoc","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelrsweet%2Fcodedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelrsweet%2Fcodedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelrsweet%2Fcodedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelrsweet%2Fcodedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelrsweet","download_url":"https://codeload.github.com/michaelrsweet/codedoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244829421,"owners_count":20517303,"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":["code","documentation","epub","html","man"],"created_at":"2024-10-12T08:43:57.318Z","updated_at":"2025-03-21T16:31:00.391Z","avatar_url":"https://github.com/michaelrsweet.png","language":"C","funding_links":["https://github.com/sponsors/michaelrsweet","https://liberapay.com/michaelrsweet"],"categories":[],"sub_categories":[],"readme":"Codedoc v3.8\n============\n\n![Version](https://img.shields.io/github/v/release/michaelrsweet/codedoc?include_prereleases)\n![Apache 2.0](https://img.shields.io/github/license/michaelrsweet/codedoc)\n\nCodedoc is a general-purpose utility which scans HTML, markdown, C, and C++\nsource files to produce EPUB, HTML, and man page documentation that can be read\nby humans.  Unlike popular C/C++ documentation generators like Doxygen or\nJavadoc, Codedoc uses in-line comments rather than comment headers, allowing for\nmore \"natural\" code documentation.  Additional markdown documentation content\ncan be included to make the generated documentation even more useful and\ncomplete.\n\nCodedoc was originally bundled with the Mini-XML library as the `mxmldoc`\nutility.\n\n\nBuilding Codedoc\n----------------\n\nCodedoc comes with the usual configure script and makefile that will work on\nmost Linux/UNIX systems and macOS.  Prerequisites include ZLIB 1.1 or later and\nMini-XML 4.x.\n\nRun the following commands to build the software:\n\n    ./configure\n    make\n\nThe default install prefix is `/usr/local`, which can be overridden using the\n`--prefix` option:\n\n    ./configure --prefix=/some/other/directory\n    make\n\n\nInstalling Codedoc\n------------------\n\nTo install the software, run:\n\n    sudo make install\n\n\nDocumentation\n-------------\n\nThe codedoc man page provides documentation on how to use it.  Further\ndocumentation can be found in the file \"DOCUMENTATION.md\" and the generated\n\"codedoc.html\" file.\n\n\nGetting Help And Reporting Problems\n-----------------------------------\n\nThe codedoc project page provides access to the Github issue tracking page:\n\n    https://www.msweet.org/codedoc\n\n\nLegal Stuff\n-----------\n\nCopyright © 2003-2025 by Michael R Sweet\n\nCodedoc is licensed under the Apache License Version 2.0.  See the files\n\"LICENSE\" and \"NOTICE\" for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelrsweet%2Fcodedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelrsweet%2Fcodedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelrsweet%2Fcodedoc/lists"}