https://github.com/danvratil/vscode-qtdoc
VSCode Extension to display Qt documentation inline
https://github.com/danvratil/vscode-qtdoc
documentation extension qt typescript vscode vscode-extension
Last synced: 4 months ago
JSON representation
VSCode Extension to display Qt documentation inline
- Host: GitHub
- URL: https://github.com/danvratil/vscode-qtdoc
- Owner: danvratil
- License: mit
- Created: 2024-05-11T20:27:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-12T17:13:07.000Z (6 months ago)
- Last Synced: 2026-01-25T19:10:10.828Z (5 months ago)
- Topics: documentation, extension, qt, typescript, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=dvratil.vscode-qtdoc
- Size: 620 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VS Code Qt Documentation Extension
This extension shows documentation for Qt methods and types when you hover over
them.
https://github.com/danvratil/vscode-qtdoc/assets/932001/cea89414-4ae6-4f24-ae13-49f7a098fa91
## Setup & Configuration
After installing the extension, it may be necessary to configure paths to
where the Qt documentation is installed on your system.
### Linux
The extension will automatically search for Qt documentation files (`.qch`)
in `/usr/share/doc/qt5/` and `/usr/share/doc/qt6/`. Those paths (and files in
them) are usually provided by distribution packages. If you have your Qt
documentation installed in other location, you can specify the path in the
extension settings.
### MacOS & Windows
On MacOS and Windows it is necessary to configure the paths to Qt documentation
manually. After installation, the extension will inform you that there are no
search paths configured and ask you to set them up.
## Extension Settings
This extension contributes the following settings:
* `qtdoc.paths`: Paths to search for QCH files.
## Known Issues
* Constructors don't show documentation (issue #1)
* QML not supported (issue #2)
* Documentation for overloaded methods is not resolved correctly (issue #3)
## Contributing
You are more than welcome to contribute to this project, be it code,
documentation, localization or whatever else. Thank you!
To get started, simply fork our repository on GitHub, create a new branch
for your changes, and submit a pull request when you're ready.
## FAQ
### Where to Get Qt Documentation?
On Linux, it's usually available through distribution packages (usually called
`qt6-doc` in most distros). Other way how to obtain the documentation, which
applies to any platform is through the official
[Qt Installer](https://www.qt.io/download-qt-installer-oss). Finally, it's
also possible to build the Qt documentation yourself
[directly from Qt sources](https://wiki.qt.io/Building_Qt_Documentation),
either standalone or as part of compiling Qt yourself.
### Why a Special Extension for Qt?
Unlike most C++ projects, Qt keeps its API documentation in the `.cpp` files.
Therefore when developing against Qt, the C++ Intellisense cannot see it, since
it only has access to Qt header files.
Qt instead compiles its documentation into a properietary QCH (Qt Compressed
Help) format (which really is just an SQLite database). This extension extracts
all documented symbols from the database and their documentation, so when you
hover over a Qt type or it's method, the extension can quickly look up the
documentation for it and provide it to VS Code.
## License
This project is published under the [MIT license](LICENSES/MIT.txt).