On Wed, Oct 2, 2013 at 10:31 AM, Pasion Jerome <[email protected]>wrote:
> Hello, > > I'm curious to know if this is a heavily requested feature. Could you > file a bug or request? > > We can have an annotated lists where the description taken from the \brief > is in another column. > "QML Types - Module - Since" also makes sense to me. > > The major issue is that the All Classes and All QML Types pages will be > slower to load. > > > Cheers, > Jerome P. > Documentation Engineer - Digia, Qt > > ------------------------------ > *Fra:* Mark [[email protected]] > *Sendt:* 27. september 2013 18:42 > *To:* Pasion Jerome > *Cc:* [email protected] > *Emne:* Re: [Development] Documentation todo for Qt 5.2 > > On Fri, Sep 27, 2013 at 1:33 PM, Pasion Jerome > <[email protected]>wrote: > >> Hello all, >> >> Moving forward, this is a sanity check list related to documentation. >> I would like to get people to start looking at their content for missing >> documentation sooner than later. >> >> (I'm linking to the documentation from stable, but these should apply to >> all Qt 5 branches) >> >> Mainly: >> - New modules should be listed as either an "Essential" or an "Add-On": >> http://doc-snapshot.qt-project.org/qt5-stable/qtmodules.html >> -Classes should be in the "All Classes" page: >> http://doc-snapshot.qt-project.org/qt5-stable/classes.html >> -QML types should be in the "All QML Types" page: >> http://doc-snapshot.qt-project.org/qt5-stable/qmltypes.html >> -pages should be accessible from the main page through the "Overviews", >> "Reference", and "Getting Started" sections. (Don't bury the pages so >> nobody can find them). >> -wiki material (which is convenient during the planning and development >> phases) should be ported over to the Qt reference so they get packaged with >> the installers. >> -the same requirements for every module still apply: landing page, C++ >> classes page, QML types page, examples, and overview. The requirements are >> in the Qt Writing Guidelines wiki. >> >> These points are also in the Qt Writing Guidelines: >> http://qt-project.org/wiki/QtWritingGuidelines including a checklist for >> adding documentation to a new module. >> We also have an umbrella bug report covering Qt 5.2 documentation issues: >> https://bugreports.qt-project.org/browse/QTBUG-32173 >> As always, feel free to ask questions or if your project has an exotic >> setup that we should know about. >> >> Cheers, >> Jerome P. >> Documentation Engineer - Digia, Qt >> >> _______________________________________________ >> Development mailing list >> [email protected] >> http://lists.qt-project.org/mailman/listinfo/development >> >> > Hi, > > I've browsed through the All QML types and All Classes, but i really > miss an easy way to see when a specific class (or QML type) got added in Qt. > Would it be possible to change it to something like this: > > All classes > A Since > QAbstractAnimation 4.6 > ... ... > > So just adding a "Since" column to give you a very easy fast overview of > when a class got introduced. > The same for QML types obviously. > > Cheers, > Mark > Done: https://bugreports.qt-project.org/browse/QTBUG-33823 If you have a second, please fix the title. I didn't check the title before posting the feature...
_______________________________________________ Development mailing list [email protected] http://lists.qt-project.org/mailman/listinfo/development
