Commit Graph

12 Commits

Author SHA1 Message Date
Topi Reinio
e4b3e47935 Doc: Add a comment into config.qdocconf about generating internal docs
QDoc supports the --showinternal command line option, but it's
not integrated to the build system.

This commit documents an alternative way to get documentation marked as
internal generated, replacing every instance of \internal with a text
string '[internal]'

Change-Id: Ib48ade21adf32d430e62b95c4baa64be620d7eb0
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Martin Smith <martin.smith@qt.io>
2017-02-07 08:36:00 +00:00
Topi Reinio
a85ed40004 Doc: Documentation template: Bump copyright year
Change-Id: Ic2dfce35f9bfabc94b170f3dfaa3172630918330
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-01-26 10:56:34 +00:00
Kai Koehne
c8afc67875 Automatically generate code attribution documentation
Let the qtattributionsscanner tool generate a .qdoc file in
the build directory that contains code attributions for
this qdoc module.

Task-number: QTBUG-55139
Change-Id: Ic7532c9a7c092f552c36e21ee6cbebdd0107689b
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-08-10 06:11:18 +00:00
Kai Koehne
7c797b4905 Bump copyright year to 2016
Bump copyright year in tool output and user visible strings to 2016.

Task-number: QTBUG-50578
Change-Id: I2f4aa9089c6672726f554cba7e6009b425d27683
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2016-01-29 13:30:04 +00:00
Jani Heikkinen
83a5694dc2 Update copyright headers
Qt copyrights are now in The Qt Company, so we could update the source
code headers accordingly. In the same go we should also fix the links to
point to qt.io.

Outdated header.LGPL removed (use header.LGPL21 instead)

Old header.LGPL3 renamed to header.LGPL3-COMM to match actual licensing
combination. New header.LGPL-COMM taken in the use file which were
using old header.LGPL3 (src/plugins/platforms/android/extract.cpp)

Added new header.LGPL3 containing Commercial + LGPLv3 + GPLv2 license
combination

Change-Id: I6f49b819a8a20cc4f88b794a8f6726d975e8ffbe
Reviewed-by: Matti Paaso <matti.paaso@theqtcompany.com>
2015-02-11 06:49:51 +00:00
Kai Koehne
ecd74bcc94 Bump copyright year to 2015
Bump copyright year in tool output and user visible strings to 2015.

Change-Id: I9b29907fe3f555e78005cb296a49d92f601fb7ec
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-01-15 09:24:51 +01:00
Topi Reinio
457496b830 Doc: new template for qt.io online style
An online documentation template that follows the
style of qt.io site.

Update the url variable for Qt modules to point
to doc.qt.io/qt-5/.

Task-number: QTBUG-42086
Change-Id: I5428a02cd503aef2217efd7361f4c8b7b5895a52
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2014-12-03 12:20:07 +01:00
Jerome Pasion
c8e7fe7f35 Doc: Removed minor version from the doc URL.
-The online URL doesn't use the minor version
anymore and this makes the non-Qt projects
depend on the existence of redirects.

Change-Id: I5b2bef16957ca307060600b7bf25eb1d55f2c998
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-08-15 13:09:02 +02:00
Jerome Pasion
7c99231c55 Doc: Add Qt 5 URL in qtbase/doc/global
-individual Qt 5 modules have the same URL and it can be inherited
 from doc/global

Change-Id: Ie53fe7509a4f906740512e290e263d34ba3f2ee6
Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-07-04 12:05:01 +02:00
Jerome Pasion
e14ef58f3d Doc: Add a section all modules can use for example documentation.
-modules that use the qt-module-defaults.qdocconf have access to the
 .qdocinc file.

-content about running examples can be used by example documentation.

Task-number: QTBUG-33597
Change-Id: I88d93a9982c05a24b4f7ac1b2cfb3293e56031b2
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-04-09 10:37:29 +02:00
Kai Koehne
e7270b68fe Doc: Update year to 2014
Change-Id: Iae2f31232fb364b26aa4da99048d92c262b4fdec
Reviewed-by: Sergio Ahumada <sahumada@blackberry.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-03-27 15:22:33 +01:00
Jerome Pasion
b11cb96f28 Doc: Fixed QDoc's navigation mechanism.
The HTML pages need to display minimal navigation such
as a link to the module landing page or Qt 5's index.html.

-new variables available in qdocconf files:
    navigation.landingpage
    navigation.homepage
    navigation.cppclassespage
    navigation.qmltypespage
    buildversion

The navigation variables are for the new navigation bar.
The buildversion variable is to insert documentation build
information into the pages.

Note about compatibility with Qt Creator docs:
The HTML template files for Qt Creator is retained to keep
Qt Creator compatible with 5.0.x and 5.1.x.

Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-06-25 14:03:24 +02:00