[Development] ODP: Missing documentation

Nowacki Jedrzej Jedrzej.Nowacki at digia.com
Fri Feb 21 11:05:14 CET 2014


> >    QString::Data
> Internal type, doesn't need documentation.

Missing documentation is not equal to marking something as internal. QDoc will complain. To make it proper you are expected to use \internal tag. QString::Data is a public typedef.

________________________________________
Od: development-bounces+jedrzej.nowacki=digia.com at qt-project.org [development-bounces+jedrzej.nowacki=digia.com at qt-project.org] w imieniu Thiago Macieira [thiago.macieira at intel.com]
Wysłano: 20 lutego 2014 18:15
Do: development at qt-project.org
Temat: Re: [Development] Missing documentation

Em qui 20 fev 2014, às 22:32:35, Sze Howe Koh escreveu:
>     QAbstractOpenGLFunctions::initializeOpenGLFunctions()

That's an internal function.

>     QByteArray::setNum()

Those are documented.

>     QString::Data

Internal type, doesn't need documentation.

How did you create the list? In my quick check, a few of the items are
correctly identified as lacking documentation, but the above don't make sense.

--
Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center

_______________________________________________
Development mailing list
Development at qt-project.org
http://lists.qt-project.org/mailman/listinfo/development


More information about the Development mailing list