[Development] How to build Qt5's docs?

[Alan Ezust]

I've been having trouble building qch_docs also. I am told it is
broken at the moment. Please let us know when it works again.
make online_docs seems to work.

I thought I'd post my experience trying to build qch docs since it is
different from loaden's.


[ezust at cerberus] /home/ezust/Trolltech/qt5/qtdoc> make qch_docs
[ ... ]
Error in line 15310: Missing attribute in keyword at line 15310.
make[1]: *** [qch_docs] Error 255
make[1]: Leaving directory `/home/ezust/Trolltech/qt5/qtdoc/doc'
make: *** [sub-doc-qch_docs] Error 2
[ezust at cerberus] /home/ezust/Trolltech/qt5/qtdoc>
opening doc/html/qt.qch and going to line 15310 we can see this:
            <keyword name="QImageCleanupFunction"
id="QImageCleanupFunction" ref=""/>


I found that by adding a \headerfile directive in qimage.cpp like so

diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp
index 71ec636..e48d675 100644
--- a/src/gui/image/qimage.cpp
+++ b/src/gui/image/qimage.cpp
@@ -602,6 +602,7 @@ bool QImageData::checkForAlphaPixels() const
     \code
     void myImageCleanupHandler(void *info);
     \endcode
+    \headerfile qimage.h
 */

 /*!
I was able to make that particular error go away for me.
I get an error a little later with another ref="", this one for "data".

Should I try to submit this first thing as a patch to gerrit?

I am not sure how to find this other "data" error yet.





On Mon, Aug 20, 2012 at 12:46 AM,  <lars.knoll at nokia.com> wrote:
> On Aug 18, 2012, at 3:19 PM, ext Loaden <loaden at gmail.com> wrote:
>
> I want to build Qt5's docs (qch), but failing always.
>
>> make docs >>doc.log 2>&1
>
>
> Error Message:
>>
>> threed.pro -o Makefile ) && make -f Makefile docs
>> make[3]: Entering directory
>> `/home/loaden/qpSOFT/Projects/BuildQt5-x64/qt3d/src/threed'
>> /home/loaden/qpSOFT/Projects/BuildQt5-x64/qtbase/bin/qdoc -installdir
>> /home/loaden/qpSOFT/Projects/BuildQt5-x64/qtbase/doc
>> /home/loaden/qpSOFT/Projects/Qt5/qt3d/src/threed/doc/qt3d.qdocconf
>> /home/loaden/qpSOFT/Projects/Qt5/qt3d/src/threed/doc/qt3d.qdocconf:1:
>> error: Cannot open file
>> '/home/loaden/qpSOFT/Projects/Qt5/qt3d/src/threed/doc/../../../doc/global/qt-html-templates-offline.qdocconf':
>> No such file or directory
>> Cannot open file
>> '/home/loaden/qpSOFT/Projects/Qt5/qt3d/src/threed/doc/../../../doc/global/qt-html-templates-offline.qdocconf':
>> No such file or directory
>>
>> Aborting
>> make[3]: *** [docs] Error 1
>> make[3]: Leaving directory
>> `/home/loaden/qpSOFT/Projects/BuildQt5-x64/qt3d/src/threed'
>> make[2]: *** [sub-threed-docs_ordered] Error 2
>> make[2]: Leaving directory
>> `/home/loaden/qpSOFT/Projects/BuildQt5-x64/qt3d/src'
>> make[1]: *** [sub-src-docs] Error 2
>> make[1]: Leaving directory
>> `/home/loaden/qpSOFT/Projects/BuildQt5-x64/qt3d'
>> make: *** [module-qt3d-docs] Error 2
>
>
> Why?
>
>
> There's currently two ways to build documentation. A modular one (the one
> you chose) and one way where we build global docs as in Qt 4. The first
> approach is still work in progress (even though it's what we want to have in
> the long term).
>
> The second approach requires running qtdoc on some .qdocconf file in the
> qtdocs module (plus maybe some additional black magic ;-)
>
> Cheers,
> Lars
>
>
> _______________________________________________
> Development mailing list
> Development at qt-project.org
> http://lists.qt-project.org/mailman/listinfo/development
>