[Qt-creator] Custom Documentation in QtCreator

thomas vincent vrince at gmail.com
Thu Mar 29 13:55:54 CEST 2012


The whole c++/stl .qch packages are amazingly useful.
I am sad I did find out about these sooner !
Is there a reason those packages are not available through the SDK/QTC
installer ?
I quite sure Qt-Creator users will love having the kind of
documentation by default ...
Thanks

2012/3/29 Mohammad Mirzadeh <mirzadeh at gmail.com>:
>
> WOW! This is super cool. I'll give it a try and see if I can do it. Thanks
>
>
> On Wed, Mar 28, 2012 at 9:22 PM, Cristian Tibirna <tibirna at kde.org> wrote:
>>
>> On Wednesday 28 March 2012 17:11:04 Mohammad Mirzadeh wrote:
>> > Hi,
>> >
>> > Is it possible to have custom class documentation inside QtCreator? I
>> > like
>> > the "F1" feature of QtCreator for built-in classes and was thinking if
>> > it
>> > possible to extend it to my own classes?
>>
>> Of course.
>>
>> If your code is documented with doxygen format, you can use doxygen to
>> extract
>> and compile your code's documentation into a .qch package (see doxygen
>> documentation for full details) that you can then add to qtcreator using
>> the
>> configuration dialog's "Help" section.
>>
>> If you can't get around to the process, write to me in private, I will try
>> to
>> recover our procedure and describe it in detail.
>>
>> Also, you might find of interest that there already are .qch packages
>> available for the Linux man pages (system calls), C++ reference and STL:
>>
>> http://qt-project.org/wiki/Qt_Creator_Documentation_Gallery
>>
>> --
>> Cristian Tibirna
>> KDE developer .. tibirna at kde.org .. http://www.kde.org
>>
>> _______________________________________________
>> Qt-creator mailing list
>> Qt-creator at qt-project.org
>> http://lists.qt-project.org/mailman/listinfo/qt-creator
>
>
>
> _______________________________________________
> Qt-creator mailing list
> Qt-creator at qt-project.org
> http://lists.qt-project.org/mailman/listinfo/qt-creator
>



More information about the Qt-creator mailing list