Qt Creator Documentation gallery: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
= Qt Creator Documentation Gallery = | = Qt Creator Documentation Gallery = | ||
This page is meant to list 3rd party documentation files in .qch format that can get | This page is meant to list 3rd party documentation files in .qch format that can get "integrated into Qt Creator":http://doc.qt.nokia.com/qtcreator-snapshot/creator-help.html. | ||
== Documentation == | == Documentation == | ||
| Line 11: | Line 11: | ||
C++ related documentation. | C++ related documentation. | ||
* | * "C++ reference documentation":https://docs.google.com/leaf?id=0B6w3G_xx1dDnMjYyMjQ1ODctNGZmMy00MzRhLWJlOGEtMDdhOTc0N2EzOTgx&sort=name&layout=list&num=50 | ||
* | * "C++ reference documentation":http://en.cppreference.com/w/Cppreference:Archives | ||
=== CMake === | === CMake === | ||
| Line 18: | Line 18: | ||
CMake 3.0.0 and upwards can use Sphinx to generate a .qch file. | CMake 3.0.0 and upwards can use Sphinx to generate a .qch file. | ||
* | * "CMake 3.0.0 Documentation":http://www.kdab.com/context-sensitive-cmake-documentation-qtcreator/ | ||
Note that Qt Creator 3.2 beta or higher is required for context help (F1) support. | Note that Qt Creator 3.2 beta or higher is required for context help (F1) support. | ||
| Line 24: | Line 24: | ||
=== Qwt === | === Qwt === | ||
* | * "Qwt - Qt Widgets for Technical Applications" : | ||
** | ** "Qwt-6.1.0 .qhc file":http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download | ||
** | ** "Qwt-6.0.1 .qhc file":http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download | ||
=== KDE === | === KDE === | ||
| Line 32: | Line 32: | ||
KDE related documentation. | KDE related documentation. | ||
* | * "KDE API reference documentation":http://api.kde.org/ is available in .qch format! | ||
=== LLVM === | === LLVM === | ||
| Line 40: | Line 40: | ||
=== STL === | === STL === | ||
* | * "STL documentation":http://www.steveire.com/libstdc++-v3.qch | ||
=== OpenGL === | === OpenGL === | ||
* | * "OpenGL Help for Qt Creator":http://code.google.com/p/qtcreator-openglhelp/ | ||
=== OGRE === | === OGRE === | ||
* | * "Integrating API documentation into Qt Creator Help":http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help | ||
=== Linux Man Pages === | === Linux Man Pages === | ||
This Qt help file contains ''Section 2: System calls'' and ''Section 3: Library function'' of the ''Linux Man Pages''. Context-sensitive help by pressing F1 is also available. | This Qt help file contains ''Section 2: System calls'' and ''Section 3: Library function'' of the ''Linux Man Pages''. Context-sensitive help by pressing F1 is also available. | ||
"site":http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/ | |||
== Converters and Generators to/for Qt help files == | == Converters and Generators to/for Qt help files == | ||
* There is a (obsolete?) | * There is a (obsolete?) "converter for CMake documentation":http://qt-apps.org/content/show.php/CMake2assistant?content=67492 to qch. | ||
Revision as of 13:31, 25 February 2015
Qt Creator Documentation Gallery
This page is meant to list 3rd party documentation files in .qch format that can get "integrated into Qt Creator":http://doc.qt.nokia.com/qtcreator-snapshot/creator-help.html.
Documentation
C++
C++ related documentation.
- "C++ reference documentation":https://docs.google.com/leaf?id=0B6w3G_xx1dDnMjYyMjQ1ODctNGZmMy00MzRhLWJlOGEtMDdhOTc0N2EzOTgx&sort=name&layout=list&num=50
- "C++ reference documentation":http://en.cppreference.com/w/Cppreference:Archives
CMake
CMake 3.0.0 and upwards can use Sphinx to generate a .qch file.
- "CMake 3.0.0 Documentation":http://www.kdab.com/context-sensitive-cmake-documentation-qtcreator/
Note that Qt Creator 3.2 beta or higher is required for context help (F1) support.
Qwt
- "Qwt - Qt Widgets for Technical Applications" :
- "Qwt-6.1.0 .qhc file":http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download
- "Qwt-6.0.1 .qhc file":http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download
KDE
KDE related documentation.
- "KDE API reference documentation":http://api.kde.org/ is available in .qch format!
LLVM
Here are instructions on how to build a Qt Compressed Help file for the LLVM source: http://llvm-reviews.chandlerc.com/D2967
STL
- "STL documentation":http://www.steveire.com/libstdc++-v3.qch
OpenGL
- "OpenGL Help for Qt Creator":http://code.google.com/p/qtcreator-openglhelp/
OGRE
- "Integrating API documentation into Qt Creator Help":http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help
Linux Man Pages
This Qt help file contains Section 2: System calls and Section 3: Library function of the Linux Man Pages. Context-sensitive help by pressing F1 is also available. "site":http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/
Converters and Generators to/for Qt help files
- There is a (obsolete?) "converter for CMake documentation":http://qt-apps.org/content/show.php/CMake2assistant?content=67492 to qch.