{"id":19732344,"url":"https://github.com/danvratil/vscode-qtdoc","last_synced_at":"2026-03-09T18:34:42.104Z","repository":{"id":239431447,"uuid":"799335077","full_name":"danvratil/vscode-qtdoc","owner":"danvratil","description":"VSCode Extension to display Qt documentation inline","archived":false,"fork":false,"pushed_at":"2026-01-12T17:13:07.000Z","size":635,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-25T19:10:10.828Z","etag":null,"topics":["documentation","extension","qt","typescript","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=dvratil.vscode-qtdoc","language":"TypeScript","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/danvratil.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["danvratil"],"liberapay":"dvratil","ko_fi":"dvratil","custom":["https://paypal.me/dvratil"]}},"created_at":"2024-05-11T20:27:21.000Z","updated_at":"2025-12-10T20:58:00.000Z","dependencies_parsed_at":"2024-05-15T13:15:21.002Z","dependency_job_id":"39569222-d4e8-4793-9f47-53c7ae019ec1","html_url":"https://github.com/danvratil/vscode-qtdoc","commit_stats":null,"previous_names":["danvratil/vscode-extension-qch","danvratil/vscode-qtdoc"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/danvratil/vscode-qtdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danvratil%2Fvscode-qtdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danvratil%2Fvscode-qtdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danvratil%2Fvscode-qtdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danvratil%2Fvscode-qtdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danvratil","download_url":"https://codeload.github.com/danvratil/vscode-qtdoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danvratil%2Fvscode-qtdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30307451,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T17:35:44.120Z","status":"ssl_error","status_checked_at":"2026-03-09T17:35:43.707Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["documentation","extension","qt","typescript","vscode","vscode-extension"],"created_at":"2024-11-12T00:25:55.613Z","updated_at":"2026-03-09T18:34:42.092Z","avatar_url":"https://github.com/danvratil.png","language":"TypeScript","funding_links":["https://github.com/sponsors/danvratil","https://liberapay.com/dvratil","https://ko-fi.com/dvratil","https://paypal.me/dvratil"],"categories":[],"sub_categories":[],"readme":"# VS Code Qt Documentation Extension\n\nThis extension shows documentation for Qt methods and types when you hover over\nthem.\n\nhttps://github.com/danvratil/vscode-qtdoc/assets/932001/cea89414-4ae6-4f24-ae13-49f7a098fa91\n\n## Setup \u0026 Configuration\n\nAfter installing the extension, it may be necessary to configure paths to\nwhere the Qt documentation is installed on your system.\n\n### Linux\n\nThe extension will automatically search for Qt documentation files (`.qch`)\nin `/usr/share/doc/qt5/` and `/usr/share/doc/qt6/`. Those paths (and files in\nthem) are usually provided by distribution packages. If you have your Qt\ndocumentation installed in other location, you can specify the path in the\nextension settings.\n\n### MacOS \u0026 Windows\n\nOn MacOS and Windows it is necessary to configure the paths to Qt documentation\nmanually. After installation, the extension will inform you that there are no\nsearch paths configured and ask you to set them up.\n\n## Extension Settings\n\nThis extension contributes the following settings:\n\n* `qtdoc.paths`: Paths to search for QCH files.\n\n## Known Issues\n\n* Constructors don't show documentation (issue #1)\n* QML not supported (issue #2)\n* Documentation for overloaded methods is not resolved correctly (issue #3)\n\n## Contributing\n\nYou are more than welcome to contribute to this project, be it code,\ndocumentation, localization or whatever else. Thank you!\n\nTo get started, simply fork our repository on GitHub, create a new branch\nfor your changes, and submit a pull request when you're ready.\n\n## FAQ\n\n### Where to Get Qt Documentation?\n\nOn Linux, it's usually available through distribution packages (usually called\n`qt6-doc` in most distros). Other way how to obtain the documentation, which\napplies to any platform is through the official\n[Qt Installer](https://www.qt.io/download-qt-installer-oss). Finally, it's\nalso possible to build the Qt documentation yourself\n[directly from Qt sources](https://wiki.qt.io/Building_Qt_Documentation),\neither standalone or as part of compiling Qt yourself.\n\n### Why a Special Extension for Qt?\n\nUnlike most C++ projects, Qt keeps its API documentation in the `.cpp` files.\nTherefore when developing against Qt, the C++ Intellisense cannot see it, since\nit only has access to Qt header files.\n\nQt instead compiles its documentation into a properietary QCH (Qt Compressed\nHelp) format (which really is just an SQLite database). This extension extracts\nall documented symbols from the database and their documentation, so when you\nhover over a Qt type or it's method, the extension can quickly look up the\ndocumentation for it and provide it to VS Code.\n\n## License\n\nThis project is published under the [MIT license](LICENSES/MIT.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanvratil%2Fvscode-qtdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanvratil%2Fvscode-qtdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanvratil%2Fvscode-qtdoc/lists"}