Qt Creator Documentation gallery: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(Add "cleanup" tag)
(Convert ExpressionEngine links)
Line 5: Line 5:
= Qt Creator Documentation Gallery =
= 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.
This page is meant to list 3rd party documentation files in .qch format that can get [http://doc.qt.nokia.com/qtcreator-snapshot/creator-help.html integrated into Qt Creator].


== Documentation ==
== Documentation ==
Line 13: Line 13:
C++ related documentation.
C++ related documentation.


* "C++ reference documentation":https://docs.google.com/leaf?id=0B6w3G_xx1dDnMjYyMjQ1ODctNGZmMy00MzRhLWJlOGEtMDdhOTc0N2EzOTgx&sort=name&layout=list&num=50
* [https://docs.google.com/leaf?id=0B6w3G_xx1dDnMjYyMjQ1ODctNGZmMy00MzRhLWJlOGEtMDdhOTc0N2EzOTgx&sort=name&layout=list&num=50 C++ reference documentation]
* "C++ reference documentation":http://en.cppreference.com/w/Cppreference:Archives
* [http://en.cppreference.com/w/Cppreference:Archives C++ reference documentation]


=== CMake ===
=== CMake ===
Line 20: Line 20:
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/
* [http://www.kdab.com/context-sensitive-cmake-documentation-qtcreator/ CMake 3.0.0 Documentation]


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 27: Line 27:


* "Qwt - Qt Widgets for Technical Applications" :
* "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
** [http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download Qwt-6.1.0 .qhc file]
** "Qwt-6.0.1 .qhc file":http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download
** [http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download Qwt-6.0.1 .qhc file]


=== KDE ===
=== KDE ===
Line 34: Line 34:
KDE related documentation.
KDE related documentation.


* "KDE API reference documentation":http://api.kde.org/ is available in .qch format!
* [http://api.kde.org/ KDE API reference documentation] is available in .qch format!


=== LLVM ===
=== LLVM ===
Line 42: Line 42:
=== STL ===
=== STL ===


* "STL documentation":http://www.steveire.com/libstdc++-v3.qch
* [http://www.steveire.com/libstdc++-v3.qch STL documentation]


=== OpenGL ===
=== OpenGL ===


* "OpenGL Help for Qt Creator":http://code.google.com/p/qtcreator-openglhelp/
* [http://code.google.com/p/qtcreator-openglhelp/ OpenGL Help for Qt Creator]


=== OGRE ===
=== OGRE ===


* "Integrating API documentation into Qt Creator Help":http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help
* [http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help 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/
[http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/ site]


== Converters and Generators to/for Qt help files ==
== 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.
* There is a (obsolete?) [http://qt-apps.org/content/show.php/CMake2assistant?content=67492 converter for CMake documentation] to qch.

Revision as of 15:31, 4 March 2015

This article may require cleanup to meet the Qt Wiki's quality standards. Reason: Auto-imported from ExpressionEngine.
Please improve this article if you can. Remove the {{cleanup}} tag and add this page to Updated pages list after it's clean.

Qt Creator Documentation Gallery

This page is meant to list 3rd party documentation files in .qch format that can get integrated into Qt Creator.

Documentation

C++

C++ related documentation.

CMake

CMake 3.0.0 and upwards can use Sphinx to generate a .qch file.

Note that Qt Creator 3.2 beta or higher is required for context help (F1) support.

Qwt

KDE

KDE related documentation.

LLVM

Here are instructions on how to build a Qt Compressed Help file for the LLVM source: http://llvm-reviews.chandlerc.com/D2967

STL

OpenGL

OGRE

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

Converters and Generators to/for Qt help files