[Development] doc: need rename qdoc3 -> qdoc
casper.vandonderen at nokia.com
casper.vandonderen at nokia.com
Fri Jun 22 10:07:59 CEST 2012
Hi,
First of all: the monolithic build in qtdoc will be removed once all modules contain their own "make docs" target, since that monolithic build does not allow the same filename in any module, in the future each module should probably have a page with:
/*!
\title [libraryname] index
\page index.html
*/
Then you can link to the module index from any other module that depends on it.
The blue and white stylesheet is the new offline style that we also use for Creator (blue is better than green for colorblind people apparently), I have not had the time yet to put an online style in place (and I don't know yet how we want to support the current online style, since some of the side-menu entries use downstream linking and are hard-coded in the HTML pages themselves).
Casper
________________________________________
From: Blasche Alex (Nokia-MP/Brisbane)
Sent: Friday, June 22, 2012 6:42 AM
To: Vandonderen Casper (Nokia-MP/Oslo); development at qt-project.org
Subject: RE: [Development] doc: need rename qdoc3 -> qdoc
Hi,
How is this individual module generation supposed to tie into the global doc generation which kind of still works by going into qtdoc and running "make docs"? Or isn't there a hook?
Also it seems that qtbase uses once again a completely new stylesheet set (blue and white). I would really appreciate a bit more information than the snippet above.
--
Alex
>-----Original Message-----
>From: development-bounces+alex.blasche=nokia.com at qt-project.org
>[mailto:development-bounces+alex.blasche=nokia.com at qt-project.org] On
>Behalf Of Vandonderen Casper (Nokia-MP/Oslo)
>Sent: Monday, 4 June 2012 18:27
>To: loaden at gmail.com; development at qt-project.org
>Subject: Re: [Development] doc: need rename qdoc3 -> qdoc
>
>Hi,
>
>Technically this structure should not be used at all anymore, but rather the
>auto-magic we introduced.
>The preferred way is to specify QMAKE_DOCS = [qdocconf file], this will
>automatically set up a "make docs" target for this module.
>
>
>Casper
>
>From: ext Loaden <loaden at gmail.com>
>Date: Sunday, June 3, 2012 6:00 AM
>To: development <development at qt-project.org>
>Subject: [Development] doc: need rename qdoc3 -> qdoc
>
>
>See the diff show below.
>Any comments?
>
>
>
> Entering 'qlalr'
> Entering 'qt3d'
> Entering 'qtactiveqt'
> Entering 'qtbase'
> Entering 'qtconnectivity'
> diff --git a/doc/doc.pri b/doc/doc.pri
> index 459e9ba..3cd0b30 100644
> --- a/doc/doc.pri
> +++ b/doc/doc.pri
> @@ -3,10 +3,10 @@ OTHER_FILES += \
> $$PWD/qt5-dita.qdocconf
>
> docs_target.target = docs
> -docs_target.commands = qdoc3 $$PWD/qt5.qdocconf
> +docs_target.commands = qdoc $$PWD/qt5.qdocconf
>
> ditadocs_target.target = ditadocs
> -ditadocs_target.commands = qdoc3 $$PWD/qt5-dita.qdocconf
> +ditadocs_target.commands = qdoc $$PWD/qt5-dita.qdocconf
>
> QMAKE_EXTRA_TARGETS = docs_target ditadocs_target
> QMAKE_CLEAN += \
> Entering 'qtdeclarative'
> diff --git a/doc/config/qtdeclarative_doc.pri
>b/doc/config/qtdeclarative_doc.pri
> index 51f2fce..d8a3a33 100644
> --- a/doc/config/qtdeclarative_doc.pri
> +++ b/doc/config/qtdeclarative_doc.pri
> @@ -2,12 +2,12 @@ OTHER_FILES += \
> $$PWD/qtquick.qdocconf \
> $$PWD/qtquick-dita.qdocconf
>
> -online_docs.commands = qdoc3 $$PWD/qtquick.qdocconf
> +online_docs.commands = qdoc $$PWD/qtquick.qdocconf
>
> -dita_docs.commands = qdoc3 $$PWD/qtquick-dita.qdocconf
> +dita_docs.commands = qdoc $$PWD/qtquick-dita.qdocconf
>
> docs.depends = dita_docs online_docs
> QMAKE_EXTRA_TARGETS = docs dita_docs online_docs
> QMAKE_CLEAN += \
> "-r $$PWD/html" \
> - "-r $$PWD/ditaxml"
> \ No newline at end of file
> + "-r $$PWD/ditaxml"
> Entering 'qtdoc'
> Entering 'qtdocgallery'
> Entering 'qtfeedback'
> Entering 'qtgraphicaleffects'
> Entering 'qtimageformats'
> diff --git a/doc/doc.pri b/doc/doc.pri
> index e87ab19..3e401df 100644
> --- a/doc/doc.pri
> +++ b/doc/doc.pri
> @@ -3,10 +3,10 @@ OTHER_FILES += \
> $$PWD/qtimageformats-dita.qdocconf
>
> docs_target.target = docs
> -docs_target.commands = qdoc3 $$PWD/qtimageformats.qdocconf
> +docs_target.commands = qdoc $$PWD/qtimageformats.qdocconf
>
> ditadocs_target.target = ditadocs
> -ditadocs_target.commands = qdoc3 $$PWD/qtimageformats-
>dita.qdocconf
> +ditadocs_target.commands = qdoc $$PWD/qtimageformats-
>dita.qdocconf
>
> QMAKE_EXTRA_TARGETS = docs_target ditadocs_target
> QMAKE_CLEAN += \
> Entering 'qtjsbackend'
> Entering 'qtjsondb'
> Entering 'qtlocation'
> diff --git a/doc/config/qtlocation_doc.pri
>b/doc/config/qtlocation_doc.pri
> index a2e2bab..feae9eb 100644
> --- a/doc/config/qtlocation_doc.pri
> +++ b/doc/config/qtlocation_doc.pri
> @@ -7,7 +7,7 @@ win32:!win32-g++ {
> unixstyle = true
> }
>
> -QDOC = $$QT.core.bins/qdoc3
> +QDOC = $$QT.core.bins/qdoc
>
> ONLINE_CONF = $$PWD/qtlocation.qdocconf
> DITA_CONF = $$PWD/qtlocation-dita.qdocconf
> @@ -15,7 +15,6 @@ QCH_CONF = #nothing yet
>
> $$unixstyle {
> } else {
> - QDOC = $$replace(QDOC, "qdoc", "qdoc3.exe")
> ONLINE_CONF = $$replace(ONLINE_CONF, "/", "\\")
> DITA_DOCS = $$replace(ONLINE_CONF, "/", "\\")
> }
> Entering 'qtmultimedia'
> diff --git a/doc/config/qtmultimedia_doc.pri
>b/doc/config/qtmultimedia_doc.pri
> index 8aab323..9f36439 100644
> --- a/doc/config/qtmultimedia_doc.pri
> +++ b/doc/config/qtmultimedia_doc.pri
> @@ -7,15 +7,7 @@ win32:!win32-g++ {
> unixstyle = true
> }
>
> -system(which qdoc) {
> - QDOC = qdoc
> -} else {
> - exists($$QT.core.bins/qdoc3) {
> - QDOC = $$QT.core.bins/qdoc3
> - } else {
> - warning("No qdoc executable found.")
> - }
> -}
> +QDOC = $$QT.core.bins/qdoc
>
> ONLINE_CONF = $$PWD/qtmultimedia.qdocconf
> DITA_CONF = $$PWD/qtmultimedia-dita.qdocconf
> @@ -23,7 +15,6 @@ QCH_CONF = #nothing yet
>
> $$unixstyle {
> } else {
> - QDOC = $$replace(QDOC, "qdoc", "qdoc3.exe")
> ONLINE_CONF = $$replace(ONLINE_CONF, "/", "\\")
> DITA_DOCS = $$replace(ONLINE_CONF, "/", "\\")
> }
> Entering 'qtphonon'
> Entering 'qtpim'
> Entering 'qtqa'
> Entering 'qtquick1'
> Entering 'qtrepotools'
> Entering 'qtscript'
> Entering 'qtsensors'
> diff --git a/doc/config/qtsensors_doc.pri
>b/doc/config/qtsensors_doc.pri
> index 4c91758..9ce9913 100644
> --- a/doc/config/qtsensors_doc.pri
> +++ b/doc/config/qtsensors_doc.pri
> @@ -7,7 +7,7 @@ win32:!win32-g++ {
> unixstyle = true
> }
>
> -QDOC = $$QT.core.bins/qdoc3
> +QDOC = $$QT.core.bins/qdoc
>
> ONLINE_CONF = $$PWD/qtsensors.qdocconf
> DITA_CONF = $$PWD/qtsensors-dita.qdocconf
> @@ -15,7 +15,6 @@ QCH_CONF = #nothing yet
>
> $$unixstyle {
> } else {
> - QDOC = $$replace(QDOC, "qdoc", "qdoc3.exe")
> ONLINE_CONF = $$replace(ONLINE_CONF, "/", "\\")
> DITA_DOCS = $$replace(ONLINE_CONF, "/", "\\")
> }
> Entering 'qtsvg'
> Entering 'qtsystems'
> Entering 'qttools'
> Entering 'qttranslations'
> Entering 'qtwayland'
> Entering 'qtxmlpatterns'
> diff --git a/.gitignore b/.gitignore
> index 6e178a2..5cbefb5 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -67,8 +67,7 @@ bin/moc*
> bin/makeqpf*
> bin/pixeltool*
> bin/qmake*
> -bin/qdoc3*
> -bin/qt3to4*
> +bin/qdoc*
> bin/qtdemo*
> bin/qttracereplay*
> bin/rcc*
> diff --git a/doc/doc.pri b/doc/doc.pri
> index 459e9ba..3cd0b30 100644
> --- a/doc/doc.pri
> +++ b/doc/doc.pri
> @@ -3,10 +3,10 @@ OTHER_FILES += \
> $$PWD/qt5-dita.qdocconf
>
> docs_target.target = docs
> -docs_target.commands = qdoc3 $$PWD/qt5.qdocconf
> +docs_target.commands = qdoc $$PWD/qt5.qdocconf
>
> ditadocs_target.target = ditadocs
> -ditadocs_target.commands = qdoc3 $$PWD/qt5-dita.qdocconf
> +ditadocs_target.commands = qdoc $$PWD/qt5-dita.qdocconf
>
> QMAKE_EXTRA_TARGETS = docs_target ditadocs_target
> QMAKE_CLEAN += \
>
>
>
>--
>
>Please don't ask where I come from, It's a shame!
>Best Regards
>Yuchen
More information about the Development
mailing list