[Development] Qdoc || !Qdoc

Smith Martin Martin.Smith at theqtcompany.com
Wed Oct 22 10:52:15 CEST 2014

I suspect this means we no longer need the .index files in qdoc. We should have used the tag files beginning with 5.0. 

From: development-bounces+martin.smith=theqtcompany.com at qt-project.org <development-bounces+martin.smith=theqtcompany.com at qt-project.org> on behalf of Miettinen Riitta-Leena <Riitta-Leena.Miettinen at theqtcompany.com>
Sent: Wednesday, October 22, 2014 10:46 AM
To: development at qt-project.org
Subject: Re: [Development] Qdoc || !Qdoc


Take a look at a recent blog post by Lorenz Haas on Linking Qt classes in documentation generated with Doxygen: http://blog.qt.digia.com/blog/2014/08/13/qt-weekly-17-linking-qt-classes-in-documentation-generated-with-doxygen/

Best regards,

Leena Miettinen Documentation Engineer | The Qt Company

Digia Germany GmbH, Rudower Chaussee 13, D-12489 Berlin
Geschäftsführer: Mika Pälsi, Juha Varelius, Tuula Haataja Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B

Email: <email>@theqtcompany.com | Phone: +49 30 63 92 3255 www.qt.io |Qt Blog: http://blog.qt.digia.com/ | Twitter: @QtbyDigia, @Qtproject | Facebook: www.facebook.com/qt

> Date: Wed, 22 Oct 2014 09:39:58 +0200
> From: Oleksii Serdiuk <contacts at oleksii.name>
> Subject: Re: [Development] Qdoc || !Qdoc
> To: development at qt-project.org
> Message-ID: <54475F4E.1090807 at oleksii.name>
> Content-Type: text/plain; charset="windows-1252"
> Hello Martin,
> Yes, it uses index files. In Qt 4 times it was one file (qt-4.8.tags),
> but now they're split per-module (qtcore.tags, qtgui.tags, ...).
> In Doxyfile you have to set TAGFILES to path to .tags file and URL to Qt
> documentation. If you need an example, you can take a look at
> https://github.com/leppa/tspsg/blob/master/Doxyfile, line 2029.
> And if I'm not mistaken, doxygen can also generate .tags file from HTML.
> On 22/10/14 08:39, Smith Martin wrote:
>> Thanks, Kevin.
>> Do you know how doxygen finds those links? Does it use the qdoc index files, or does it construct an index from all the Qt html files?
>> martin
>> ________________________________________
>> From: development-bounces+martin.smith=theqtcompany.com at qt-project.org <development-bounces+martin.smith=theqtcompany.com at qt-project.org> on behalf of Kevin Kofler <kevin.kofler at chello.at>
>> Sent: Wednesday, October 22, 2014 3:44 AM
>> To: development at qt-project.org
>> Subject: Re: [Development] Qdoc || !Qdoc
>> Smith Martin wrote:
>>> If you want your documentation to link to the Qt documentation, it might
>>> be easier to use qdoc. I'm not sure that's correct, because I haven't
>>> actually used doxygen for that purpose, but I know you can link to Qt
>>> documentation using qdoc.
>> Doxygen can definitely link to Qt documentation, see e.g.:
>> http://api.kde.org/frameworks-api/frameworks5-apidocs/kcoreaddons/html/classKProcess.html
>> (which is generated using Doxygen, as all KDE API documentation).
>> You have to explicitly set it up for that though.
>>        Kevin Kofler
> --
> With best regards,
> Oleksii Serdiuk
> -------------- next part --------------
> A non-text attachment was scrubbed...
> Name: smime.p7s
> Type: application/pkcs7-signature
> Size: 4813 bytes
> Desc: S/MIME Cryptographic Signature
> Url : http://lists.qt-project.org/pipermail/development/attachments/20141022/d0709696/attachment-0001.bin

Development mailing list
Development at qt-project.org

More information about the Development mailing list