Commit Graph

20 Commits

Author SHA1 Message Date
Topi Reinio
a0127da1fd Doc: Clear a number of documentation warnings
QDoc gets confused about the contents of doc_src_plugins.qdoc,
mistaking some of its code for QDoc commands.

To work around this problem, change the file to be a qdoc
include file, wrap the code blocks with \badcode, and
refer to them using \include.

Using \badcode will also turn off code highlighting and
autolinking, something that is not desired for these code
snippets.

Change-Id: I6c3b65ef098ec6f6f06892d78a3abb38e0d28ca3
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-09-10 10:44:00 +02:00
Leena Miettinen
d59d8b568d Doc: replace "Mac OS (X)" with "OS X"
Change-Id: I77f1cbbfc17d759d1587caf2a25a53498848e2ca
Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-05-06 09:35:45 +02:00
Topi Reinio
627e2b4807 Doc: Use the page title for linking to index.html
Because the Qt Creator documentation depends on Qt reference
docs for linking, qdoc will generate a collision page for
index.html as it exists in both.

This change prevents linking to the collision page in the
navigation links by using the page title as the link target
instead of the file name.

Task-number: QTCREATORBUG-11035
Change-Id: I5638e09b60543dc2068b0e4a269f8f72d4655b48
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-03-17 14:53:01 +01:00
Leena Miettinen
7b088afbe9 Doc: don't use the term SDK in connection with Qt
Replace with "Qt distributions" or "installers" or rewrite
in some other way.

Remove references to installing Qt 4 SDK, because it is
no longer available for downloading.

Change-Id: I291f82702e21d953f2efbb0e634d6454b4bc17b9
Reviewed-by: hjk <hjk121@nokiamail.com>
2014-03-14 16:12:10 +01:00
Robert Loehning
746c5d8863 Incremented year in copyright info
Change-Id: Ib5423fdd064e4546f848c0b640b0ed0514c26d3a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
2014-01-08 08:29:47 +01:00
Leena Miettinen
e53ca2b5f6 Doc: fix a broken link Qt reference docs
"Deploying an Application on Mac OS X" has been renamed
to "Qt for Mac OS X - Deployment".

Change-Id: Idea88e83dd6ea6fd2e25fd4093c2e2cd27f632f7
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-11-28 11:11:34 +01:00
Leena Miettinen
c0704c2091 Doc: use cross-linking to Qt module documentation
Replace links to "\l{http://qt-project.org/doc/"
with links to topic titles. Remove links where QDoc
creates them automatically based on the .index files.
Add the .index files for the modules that are discussed
in the Qt Creator Manual.

Note: the links will only be generated if the Qt used to
build the docs contains the linked modules and documentation
(.index file) has been generated for them.

Change-Id: Ibe624bf3773e7c854c03ebba4db406be0b4a7b90
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-11-26 11:51:46 +01:00
Leena Miettinen
e3587e8f0d Doc: switch fixed links from Qt 4.8 to 5.0
Will look into changing automatically created links in
another patch.

Change-Id: I29b61c5301402c40d9e711762a6b57479088152b
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-03-13 11:08:27 +01:00
Leena Miettinen
a9dc98572f Doc: use prepositions more consistently: "deploy to"
Change-Id: Icf84c96b7cb300ab7d208b6b4f13276ba0b3d143
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-03-06 16:46:07 +01:00
Leena Miettinen
419c6de735 Doc: replace deprecated QDoc commands
The \i and \o commands were replaced with \li and
\bold was replaced with \b in QDoc for Qt 5.

The \input command was replaced with \include in the docs.

Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-06 09:44:18 +01:00
Robert Loehning
298531e370 Incremented year in copyright info
Change-Id: Ic6a9ff0359625021ebc061d22db6811814534205
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
2013-01-29 16:27:03 +01:00
Eike Ziller
cf937f09d6 Avoid pulling in "Extending Manual" into Qt Creator manual.
With Qt5, qdoc finds the doc/api/*.qdoc files if the examplesdir points
to doc/, leading to the two toplevel index.html files ending up within
qtcreator.qch

Change-Id: I4ac3c1447c6924c4e292024919d52ddb97e1f8cc
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2012-12-17 12:47:49 +01:00
hjk
386ca7c8dd Adjust license headers
Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-10-05 17:12:56 +02:00
Leena Miettinen
d76bc64f96 Doc: fix the link to match the topic title
Change-Id: I9e08a308409e0a604a98ef069d8604e523be6f11
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
2012-08-22 13:59:46 +02:00
Leena Miettinen
0d0121b033 Doc: switch links to point to qt-project.org
Change-Id: I136a28697c0b7aba03227387c5ce2e106c52708a
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-08-22 08:56:20 +02:00
Eike Ziller
e0e8cf3ada Contact -> qt-project.org
Change-Id: I7134d7de30bcf9f9dcfad42520dd45ee083a852d
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@nokia.com>
2012-07-19 13:23:21 +02:00
Leena Miettinen
6696a9b0d0 Doc: change the copyright year to 2012
Change-Id: I31e5f412ec2d4c371382e00503b7ebf5cc57ba02
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
2012-01-26 12:33:30 +01:00
Leena Miettinen
88e29febba Doc: restructure doc according to developer workflow
Add and remove illustrations.
Add landing pages.

Change-Id: I927d62aee9dc43814ef7f4d7424a83eee2af156b
Reviewed-by: Erik Verbruggen <erik.verbruggen@nokia.com>
2011-12-13 13:55:34 +01:00
hjk
31600758de all: s/info@qt.nokia.com/qt-info@nokia.com/
Change-Id: If18afb5d4665924e7d9250dccbc60a65e6daa75e
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
2011-11-03 10:33:19 +01:00
Leena Miettinen
910eb9b47f Doc: move info about Qt Designer and Qt widgets to a separate folder
Change-Id: I92efa66d0dc1f8ed35e16f7f8b5293806355a400
Reviewed-on: http://codereview.qt-project.org/5614
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 15:56:54 +02:00