The \a command should only be used in code documentation
(in .cpp files), where QDoc uses it to check that all
formal parameters are documented and emits warnings if
they are not or if they are misspelled.
Change-Id: I37710afcd860f9baa3042337aca98fac6701b997
Reviewed-by: Niels Weber <niels.weber@digia.com>
In Qt 5, you have to specify the index files for
the Qt 5 modules that you want to link to for QDoc
to find them. If you add the brackets in the end of
the method name, QDoc creates the links automatically
and you do not need the \l command.
Change-Id: Ia3dd78bb17e9c176747d406216930295c9fa02a8
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Each row in a table must have the same amount of
\li commands, or the table formatting breaks.
Use line breaks and empty lines if you want to
add several text paragraphs to a table cell.
Change-Id: I7a19bc883c0de18c247ca6c550dd37dba64c89d5
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
According to Apple naming conventions.
Change-Id: I4e7e5334987543118ae18d8547f58d01260f2493
Reviewed-by: Jarek Kobus <jaroslaw.kobus@digia.com>
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
The \o QDoc command has been deprecated in QDoc for
Qt 5 and using it prints a QDoc warning.
Change-Id: Ibf0be59f3953bd731c2133cee3ec399e51df84a5
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
Also allow uppercase variable names and document those.
Also update the config.xml files in the examples to uppercase.
Task-number: QTIFW-257
Change-Id: I446ed4e537cb7c15f49ba3071a9ab6591aab3329
Reviewed-by: Karsten Heimrich <karsten.heimrich@digia.com>
Change-Id: Ifef70bf0ef12b90972186f64ff9b0ae602f14420
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
Change-Id: I805a07f007cddb9fe62db986968f9f79511ffe1f
Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
- maybe this way it is easier to add more operation documenation
Change-Id: I2555f855a9519fd2c02ca014b195bca79345e138
Reviewed-on: http://codereview.qt-project.org/4420
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Tim Jenssen <tim.jenssen@nokia.com>
