{"id":23727780,"url":"https://github.com/breakthatbass/cdox","last_synced_at":"2026-04-28T17:02:50.039Z","repository":{"id":46580993,"uuid":"410126806","full_name":"breakthatbass/cdox","owner":"breakthatbass","description":"documentation generator for generating C API docs in markdown format","archived":false,"fork":false,"pushed_at":"2022-03-07T13:47:17.000Z","size":55,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-04T19:28:53.496Z","etag":null,"topics":["automation","c","documentation-generator","python"],"latest_commit_sha":null,"homepage":"","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/breakthatbass.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-24T23:26:14.000Z","updated_at":"2022-02-25T15:42:54.000Z","dependencies_parsed_at":"2022-07-20T06:32:11.012Z","dependency_job_id":null,"html_url":"https://github.com/breakthatbass/cdox","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/breakthatbass/cdox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakthatbass%2Fcdox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakthatbass%2Fcdox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakthatbass%2Fcdox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakthatbass%2Fcdox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/breakthatbass","download_url":"https://codeload.github.com/breakthatbass/cdox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breakthatbass%2Fcdox/sbom","scorecard":{"id":251735,"data":{"date":"2025-08-11","repo":{"name":"github.com/breakthatbass/cdox","commit":"81f0b1cb2eec252d1aeb5053952a6d330f93c26b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python-package.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/breakthatbass/cdox/python-package.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/breakthatbass/cdox/python-package.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-package.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/breakthatbass/cdox/python-package.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-package.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/breakthatbass/cdox/python-package.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:29","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:31","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   3 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-17T08:38:33.674Z","repository_id":46580993,"created_at":"2025-08-17T08:38:33.674Z","updated_at":"2025-08-17T08:38:33.674Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32390067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T14:34:11.604Z","status":"ssl_error","status_checked_at":"2026-04-28T14:32:37.009Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["automation","c","documentation-generator","python"],"created_at":"2024-12-31T01:30:18.315Z","updated_at":"2026-04-28T17:02:50.022Z","avatar_url":"https://github.com/breakthatbass.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cdox\n\nA script to automate documentation of your C APIs in markdown format.  \n\n`cdox` reads in a source code file creates documentation based on the comments. it's sort of like doxygen but simpler and creates a markdown file.  \n\n## Usage\n```\ncdox infile outfile\n```\n\n## Installation\n```\npip install cdox\n```\n\n## Rules \n\n**cdox keywords:**\n- `@name:` name of documentation.\n- `@description:` description of file documentation.\n- `@desc:` a description of a function.\n- `@param:` a bullet point for info on a function paramter.\n- `@return:` a bullet point for what the function returns.\n\n**rules:**\n- the keywords must be in multiline comments. \n- the multiline comments must start with `/* *` and end with `* */` each on their own line.\n- the function name/protoype must be on the line following the `* */`\n\n\n## Example Usage\nCheck out [`example.md`](https://github.com/breakthatbass/cdox/blob/main/example.md) for what the [`test.c`](https://github.com/breakthatbass/cdox/blob/main/tests/test.c) excerpt below would produce.\n#\n```C\n// test.c\n\n/* *\n * strncmp\n * \n * @desc: compare two strings up to `n` characters.\n * \n * @param: `s1` - a char array of at least one char.\n * @param: `s2` - a char array of at least one char.\n * @param: `n` - the number of chars to compare of each string.\n * \n * @return: 0 if strings are the same else a non-zero int.\n * */\nint strncmp(const char *s1, const char *s2, int n)\n{\n  while(n \u003e 0 \u0026\u0026 *s1 == *s2++) {\n    if(*s1++ == '\\0')\n      return 0;\n    n--;\n  }\n  return (n == 0 ? 0 : *s1 - *--s2);\n}\n```\n\n## todo\n- add feature to allow making section headers\n- add @global keyword for documentation of global variables\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreakthatbass%2Fcdox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbreakthatbass%2Fcdox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreakthatbass%2Fcdox/lists"}