Qt Writing Guidelines
The Qt Writing Guidelines contains information about writing Qt documentation in a consistent way. Though there are exceptions, maintain the consistency level outlined in the guidelines or the existing Qt documentation.
- Language Guidelines
- C++ Documentation Style
- QML Documentation Style
- Writing Qt Examples
- QDoc Guidelines
Related Links
- Spelling Module Names in Qt Documentation
- Qt Documentation Wiki – the main Documentation wiki which contains style information and contribution details
- QDoc Manual [doc-snapshot.qt-project.org] – contains a guide to QDoc as well as information about C++ and QML commands
- Documentation Structure page contains a map of how the directory structure of a repository or module should be
- Building Qt Documentation – outlines how to build the documentation for Qt 5 and for each module
- http://doc-snapshot.qt-project.org/ [doc-snapshot.qt-project.org] – the documentation snapshot
