[Development] Documentation Review for 5.1

Pasion Jerome Jerome.Pasion at digia.com
Thu May 16 12:15:40 CEST 2013


Hello,

For C++ API changes, it's easy to tag with the \since command ("\since 5.1", for example).
For QML types, we don't have a clear way of aggregating new changes because the types are tied to the 
QML modules ("\inqmlmodule QtQuick 2", for example).

Essentially, module identification in QML docs is not completely defined and not consistent across modules.
Some discussions involved adding parameters to the \since command or to have multiple \since commands in the QML type documentation (\since 5.1 and \since QtQuick 2.0).

 For now, we would need to specifically list the additions manually. For 5.2, I assume that the QML module versions will be incremented, so we need to look at the issue more seriously.

Cheers,
Jerome P.
________________________________________
Fra: Alan Alpert [416365416c at gmail.com]
Sendt: 16. mai 2013 01:26
To: Pasion Jerome
Cc: development at qt-project.org
Emne: Re: [Development] Documentation Review for 5.1

On Wed, May 15, 2013 at 5:05 AM, Pasion Jerome <Jerome.Pasion at digia.com> wrote:
> Hello all,
>
> I would like to ask the module maintainers (and the community in general) to
> go over the documentation before the 5.1 final packages are out.
> Specifically, the module maintainers can check that their C++ and QML APIs
> are visible and accessible.
>
> Some Qt 5.1 pages to review:
> 1) "What's New in Qt 5.1":
> http://doc-snapshot.qt-project.org/qt5-stable/qtdoc/whatsnew51.html
> 2) "New Classes and Functions in Qt 5.1":
> http://doc-snapshot.qt-project.org/qt5-stable/qtdoc/newclasses51.html

I note that this page only covers new C++ API. Does new QML API have a
separate page, or does this page need to be updated to include them?

--
Alan Alpert



More information about the Development mailing list