{"id":15750734,"url":"https://github.com/zheng-bote/header_docu","last_synced_at":"2025-03-31T07:20:53.374Z","repository":{"id":151863960,"uuid":"466091588","full_name":"Zheng-Bote/header_docu","owner":"Zheng-Bote","description":"create html- or md- based documentation from file header","archived":false,"fork":false,"pushed_at":"2022-03-20T13:11:53.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T10:49:08.343Z","etag":null,"topics":["cpp","documentation","headers","tool"],"latest_commit_sha":null,"homepage":"https://github.com/Zheng-Bote/header_docu","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zheng-Bote.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":"2022-03-04T11:08:18.000Z","updated_at":"2022-03-06T13:16:15.000Z","dependencies_parsed_at":"2023-05-12T23:00:30.339Z","dependency_job_id":null,"html_url":"https://github.com/Zheng-Bote/header_docu","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zheng-Bote%2Fheader_docu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zheng-Bote%2Fheader_docu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zheng-Bote%2Fheader_docu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zheng-Bote%2Fheader_docu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zheng-Bote","download_url":"https://codeload.github.com/Zheng-Bote/header_docu/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246429440,"owners_count":20775809,"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":["cpp","documentation","headers","tool"],"created_at":"2024-10-04T06:42:23.075Z","updated_at":"2025-03-31T07:20:53.354Z","avatar_url":"https://github.com/Zheng-Bote.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# header_docu\ncreate HTML- or Markdown- based documentation from file header\n\n\nWith great respect to Doxygen, JSDoc or DoxDox, but they all reading / parsing the complete textfile.\n\n__For me I just need parsing the first comment block of a single textfile or every textfile with a defined file-extension in a folder, doesn't matter if *.js, *.h, *.hpp or whatever__\n\nThis is the first quick \u0026 dirty version of the commandline tool, written with QT5 and C++17\n\n\n__See example__ markdown output here:\n\n\u003ca href=\"https://github.com/Zheng-Bote/ESP32_libs/wiki\" alt=\"Github ESP32\" title=\"https://github.com/Zheng-Bote/ESP32_libs/wiki\"\u003ehttps://github.com/Zheng-Bote/ESP32_libs/wiki\u003c/a\u003e\n\n\n\n\n## Roadmap:\n- [x] quick and dirty commandline parser\n\n- [ ] migrate QT commandline to vanilla cxx\n\n- [ ] build Linux and Windows desktop app with QT\n\n- [ ] build Windows desktop app with C#\n\n- [ ] CMake / make support for compilation and installation\n\n\n\n## Compile\n```\nqmake -r \"CONFIG+=release\"\nmake\n```\n\n* depending on your system environment you maybe want to modify the MAKEFILE g++ compiler option to\n```g++ -std=c++2a``` || ```-std=gnu++1z```\n\n\n# header of main.cpp\n\n- - -\n## TITLE:\n\u003e     main.cpp\n\n### BRIEF:\n\u003e     header_docu (main.cpp)\n\n### DESC:\n\u003e     header_docu is a small nafty C++ commandline tool to read the first comment block of a textfile and outputs it as HTML5- or markdown- snippet    \n\n\u003e     DEPENDENCIES:\n\u003e         cxxopts\n\u003e         a lightweight C++ option parser library, supporting the standard GNU style syntax for options.\n\u003e         https://github.com/jarro2783/cxxopts\n\n### SOURCE:\n\u003e     https://github.com/Zheng-Bote/header_docu\n\n### SYNTAX:\n\u003e     header_docu -h | header_docu --help\n\u003e     \n\u003e     -c, --css arg   include external CSS file for html output (default: false)\n\u003e     -d, --dir arg   parse directory (default: .)\n\u003e     -e, --ext arg   file extension (default: h)\n\u003e     -f, --file arg  1 single textfile\n\u003e     -o, --out arg   output type md | html (default: md)\n\u003e     -h, --help      Print usage\n\u003e     -v, --version   Version\n\n\u003e     EXAMPLES:\n\u003e     /usr/local/bin/header_docu --dir . --ext h --out md // read/parse all *.h files in the current directory\n\u003e     /usr/local/bin/header_docu --file ~/DEV/CPP/header_docu/main.cpp --out html // read/parse single file and output as HTML5\n\n### RETURN:\n\u003e     output.md | output.html\n\u003e     void\n\n### HISTORY:\n\u003e Version | Date       | Developer        | Comments\n\u003e ------- | ---------- | ---------------- | ---------------------------------------------------------------\n\u003e 0.1.0   | 2022-03-05 | RZheng           | created \n\u003e 0.1.1   | 2022-03-06 | RZheng           | fixed markdown title \n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzheng-bote%2Fheader_docu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzheng-bote%2Fheader_docu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzheng-bote%2Fheader_docu/lists"}