Qt Creator Documentation Gallery: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
=Qt Creator Documentation Gallery=
[[Category:Tools::QtCreator]]


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] ''[doc.qt.nokia.com]''.
= Qt Creator Documentation Gallery =


==Documentation==
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.


===C++===
== Documentation ==
 
=== C++ ===


C++ related documentation.
C++ related documentation.


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


===CMake===
=== CMake ===


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.


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


===Qwt===
=== Qwt ===
 
* “Qwt – Qt Widgets for Technical Applications” :
** [http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download Qwt-6.1.0 .qhc file] ''[sourceforge.net]''
** [http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download Qwt-6.0.1 .qhc file] ''[sourceforge.net]''
 
===<span class="caps">KDE</span>===


<span class="caps">KDE</span> related documentation.
* &quot;Qwt - Qt Widgets for Technical Applications&amp;quot; :
** &quot;Qwt-6.1.0 .qhc file&amp;quot;:http://sourceforge.net/projects/qwt/files/qwt/6.1.0/qwt-6.1.0.qch/download
** &quot;Qwt-6.0.1 .qhc file&amp;quot;:http://sourceforge.net/projects/qwt/files/qwt/6.0.1/qwt-6.0.1.qch/download


* [http://api.kde.org/ <span class="caps">KDE</span> <span class="caps">API</span> reference documentation] ''[api.kde.org]'' is available in .qch format!
=== KDE ===


===<span class="caps">LLVM</span>===
KDE related documentation.


Here are instructions on how to build a Qt Compressed Help file for the <span class="caps">LLVM</span> source: http://llvm-reviews.chandlerc.com/D2967
* &quot;KDE API reference documentation&amp;quot;:http://api.kde.org/ is available in .qch format!


===<span class="caps">STL</span>===
=== LLVM ===


* [http://www.steveire.com/libstdc++-v3.qch <span class="caps">STL</span> documentation] ''[steveire.com]''
Here are instructions on how to build a Qt Compressed Help file for the LLVM source: http://llvm-reviews.chandlerc.com/D2967


===OpenGL===
=== STL ===


* [http://code.google.com/p/qtcreator-openglhelp/ OpenGL Help for Qt Creator] ''[code.google.com]''
* &quot;STL documentation&amp;quot;:http://www.steveire.com/libstdc++-v3.qch


===<span class="caps">OGRE</span>===
=== OpenGL ===


* [http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help Integrating <span class="caps">API</span> documentation into Qt Creator Help] ''[ogre3d.org]''
* &quot;OpenGL Help for Qt Creator&amp;quot;:http://code.google.com/p/qtcreator-openglhelp/


===Linux Man Pages===
=== OGRE ===


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


==Converters and Generators to/for Qt help files==
=== Linux Man Pages ===


* There is a (obsolete?) [http://qt-apps.org/content/show.php/CMake2assistant?content=67492 converter for CMake documentation] ''[qt-apps.org]'' to qch.
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.<br />&quot;site&amp;quot;:http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/
* [http://www.doxygen.org/ Doxygen] ''[doxygen.org]'' has support for Qt help files. Instructions can be found [https://blog.qt.io/blog/category/doxygen2qthelp/ here] ''[blog.qt.io]''. There is also [http://dev.kofee.org/projects/qtcreator-doxygen/ a plugin for Qt Creator] ''[dev.kofee.org]''


===Categories:===
== Converters and Generators to/for Qt help files ==


* [[:Category:Tools|Tools]]
* There is a (obsolete?) &quot;converter for CMake documentation&amp;quot;:http://qt-apps.org/content/show.php/CMake2assistant?content=67492 to qch.
** [[:Category:Tools::QtCreator|QtCreator]]

Revision as of 14:33, 23 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&quot;:http://doc.qt.nokia.com/qtcreator-snapshot/creator-help.html.

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&quot;:http://shinnok.com/rants/2011/07/19/linux-man-pages-integration-with-qt-creator/

Converters and Generators to/for Qt help files

Retrieved from "https://wiki.qt.io/index.php?title=Qt_Creator_Documentation_Gallery&oldid=2881"