Remove stale documentation.

Change-Id: I85139e0334b648bee0d18129cef9387dcc6c3222
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
This commit is contained in:
Casper van Donderen 2011-10-17 14:18:42 +02:00 committed by Qt by Nokia
parent 41b01096cc
commit 0e341948ae
21 changed files with 31 additions and 565 deletions

View File

@ -1789,15 +1789,6 @@ QString QDir::currentPath()
return QFileSystemEngine::currentPath().filePath();
}
/*!
\fn QString QDir::currentDirPath()
Returns the absolute path of the application's current directory.
Use currentPath() instead.
\sa currentPath(), setCurrent()
*/
/*!
\fn QDir QDir::home()
@ -1847,16 +1838,6 @@ QString QDir::homePath()
return QFileSystemEngine::homePath();
}
/*!
\fn QString QDir::homeDirPath()
Returns the absolute path of the user's home directory.
Use homePath() instead.
\sa homePath()
*/
/*!
\fn QDir QDir::temp()
@ -1913,16 +1894,6 @@ QString QDir::rootPath()
return QFileSystemEngine::rootPath();
}
/*!
\fn QString QDir::rootDirPath()
Returns the absolute path of the root directory.
Use rootPath() instead.
\sa rootPath()
*/
#ifndef QT_NO_REGEXP
/*!
\overload

View File

@ -365,9 +365,4 @@ void QTimer::setInterval(int msec)
}
}
/*! \fn void QTimer::changeInterval(int msec)
Use setInterval(msec) or start(msec) instead.
*/
QT_END_NAMESPACE

View File

@ -589,18 +589,6 @@ void QThread::cleanup()
qt_global_mutexpool = 0;
}
/*!
\fn bool QThread::finished() const
Use isFinished() instead.
*/
/*!
\fn bool QThread::running() const
Use isRunning() instead.
*/
/*! \fn void QThread::setPriority(Priority priority)
\since 4.1

View File

@ -216,15 +216,3 @@
\sa remove()
*/
/*!
\fn QCache::QCache(int maxCost, int dummy)
Use QCache(int) instead.
*/
/*!
\fn T *QCache::find(const Key &key) const
Use object() instead.
*/

View File

@ -1282,13 +1282,6 @@ char QChar::toAscii() const
return ucs > 0xff ? 0 : char(ucs);
}
/*!
Converts the Latin-1 character \a c to it's equivalent QChar. This
is mainly useful for non-internationalized software.
\sa fromAscii(), unicode(), QTextCodec::codecForCStrings()
*/
/*!
Converts the ASCII character \a c to it's equivalent QChar. This
is mainly useful for non-internationalized software.

View File

@ -1307,11 +1307,6 @@ void QHashData::checkSanity()
\sa QHash::const_iterator, QMutableHashIterator
*/
/*! \fn QHash::iterator::operator Node *() const
\internal
*/
/*! \fn QHash::iterator::iterator()
Constructs an uninitialized iterator.
@ -1508,11 +1503,6 @@ void QHashData::checkSanity()
\sa QHash::iterator, QHashIterator
*/
/*! \fn QHash::const_iterator::operator Node *() const
\internal
*/
/*! \fn QHash::const_iterator::const_iterator()
Constructs an uninitialized iterator.

View File

@ -627,23 +627,6 @@ bool QImageData::checkForAlphaPixels() const
{Image Viewer Example}, {Scribble Example}, {Pixelator Example}
*/
/*!
\enum QImage::Endian
\compat
This enum type is used to describe the endianness of the CPU and
graphics hardware. It is provided here for compatibility with earlier versions of Qt.
Use the \l Format enum instead. The \l Format enum specify the
endianess for monchrome formats, but for other formats the
endianess is not relevant.
\value IgnoreEndian Endianness does not matter. Useful for some
operations that are independent of endianness.
\value BigEndian Most significant bit first or network byte order, as on SPARC, PowerPC, and Motorola CPUs.
\value LittleEndian Least significant bit first or little endian byte order, as on Intel x86.
*/
/*!
\enum QImage::InvertMode
@ -998,23 +981,6 @@ QImage::QImage(const char * const xpm[])
}
#endif // QT_NO_IMAGEFORMAT_XPM
/*!
\fn QImage::QImage(const QByteArray &data)
Use the static fromData() function instead.
\oldcode
QByteArray data;
...
QImage image(data);
\newcode
QByteArray data;
...
QImage image = QImage::fromData(data);
\endcode
*/
/*!
Constructs a shallow copy of the given \a image.
@ -1419,14 +1385,6 @@ QVector<QRgb> QImage::colorTable() const
return d ? d->colortable : QVector<QRgb>();
}
/*!
\obsolete
Returns the number of bytes occupied by the image data.
\sa byteCount()
*/
/*!
\since 4.6
Returns the number of bytes occupied by the image data.
@ -1618,22 +1576,6 @@ const uchar *QImage::constBits() const
return d ? d->data : 0;
}
/*!
\fn void QImage::reset()
Resets all image parameters and deallocates the image data.
Assign a null image instead.
\oldcode
QImage image;
image.reset();
\newcode
QImage image;
image = QImage();
\endcode
*/
/*!
\fn void QImage::fill(uint pixelValue)
@ -1825,22 +1767,6 @@ void QImage::invertPixels(InvertMode mode)
}
}
/*!
\fn void QImage::invertPixels(bool invertAlpha)
Use the invertPixels() function that takes a QImage::InvertMode
parameter instead.
*/
/*! \fn QImage::Endian QImage::systemByteOrder()
Determines the host computer byte order. Returns
QImage::LittleEndian (LSB first) or QImage::BigEndian (MSB first).
This function is no longer relevant for QImage. Use QSysInfo
instead.
*/
// Windows defines these
#if defined(write)
# undef write
@ -1852,14 +1778,6 @@ void QImage::invertPixels(InvertMode mode)
# undef read
#endif
/*!
\obsolete
Resizes the color table to contain \a numColors entries.
\sa setColorCount()
*/
/*!
\since 4.6
Resizes the color table to contain \a colorCount entries.
@ -3889,36 +3807,6 @@ bool QImage::isGrayscale() const
return false;
}
/*!
\fn QImage QImage::smoothScale(int width, int height, Qt::AspectRatioMode mode) const
Use scaled() instead.
\oldcode
QImage image;
image.smoothScale(width, height, mode);
\newcode
QImage image;
image.scaled(width, height, mode, Qt::SmoothTransformation);
\endcode
*/
/*!
\fn QImage QImage::smoothScale(const QSize &size, Qt::AspectRatioMode mode) const
\overload
Use scaled() instead.
\oldcode
QImage image;
image.smoothScale(size, mode);
\newcode
QImage image;
image.scaled(size, mode, Qt::SmoothTransformation);
\endcode
*/
/*!
\fn QImage QImage::scaled(int width, int height, Qt::AspectRatioMode aspectRatioMode,
Qt::TransformationMode transformMode) const
@ -4275,12 +4163,6 @@ QImage QImage::createMaskFromColor(QRgb color, Qt::MaskMode mode) const
under the terms of the QPL, Version 1.0
*/
/*!
\fn QImage QImage::mirror(bool horizontal, bool vertical) const
Use mirrored() instead.
*/
/*!
Returns a mirror of the image, mirrored in the horizontal and/or
the vertical direction depending on whether \a horizontal and \a
@ -4396,18 +4278,6 @@ QImage QImage::mirrored(bool horizontal, bool vertical) const
return result;
}
/*!
\fn QImage QImage::swapRGB() const
Use rgbSwapped() instead.
\omit
Returns a QImage in which the values of the red and blue
components of all pixels have been swapped, effectively converting
an RGB image to an BGR image. The original QImage is not changed.
\endomit
*/
/*!
Returns a QImage in which the values of the red and blue
components of all pixels have been swapped, effectively converting
@ -5091,29 +4961,6 @@ void QImage::setText(const QString &key, const QString &value)
the text is always set using QString and UTF-8 representation.
*/
/*!
\obsolete
Returns the language identifiers for which some texts are
recorded. Note that if you want to iterate over the list, you
should iterate over a copy.
The language the text is recorded in is no longer relevant since
the text is always set using QString and UTF-8 representation.
*/
/*!
\obsolete
Returns a list of QImageTextKeyLang objects that enumerate all the
texts key/language pairs set for this image.
Use textKeys() instead.
The language the text is recorded in is no longer relevant since
the text is always set using QString and UTF-8 representation.
*/
/*!
\fn void QImage::setText(const char* key, const char* language, const QString& text)
\obsolete
@ -5150,16 +4997,6 @@ void QImage::setText(const QString &key, const QString &value)
Makes a call to QPixmap::convertToImage().
*/
/*! \fn QImage::Endian QImage::systemBitOrder()
Determines the bit order of the display hardware. Returns
QImage::LittleEndian (LSB first) or QImage::BigEndian (MSB first).
This function is no longer relevant for QImage. Use QSysInfo
instead.
*/
/*!
\internal
@ -5404,22 +5241,6 @@ bool qt_xForm_helper(const QTransform &trueMat, int xoffset, int type, int depth
#undef IWX_LSB
#undef IWX_PIX
/*!
\fn QImage QImage::xForm(const QMatrix &matrix) const
Use transformed() instead.
\oldcode
QImage image;
...
image.xForm(matrix);
\newcode
QImage image;
...
image.transformed(matrix);
\endcode
*/
/*! \obsolete
Returns a number that identifies the contents of this
QImage object. Distinct QImage objects can only have the same
@ -5703,34 +5524,6 @@ int QImage::bitPlaneCount() const
return bpc;
}
/*!
\fn QImage QImage::copy(const QRect &rect, Qt::ImageConversionFlags flags) const
\compat
Use copy() instead.
*/
/*!
\fn QImage QImage::copy(int x, int y, int w, int h, Qt::ImageConversionFlags flags) const
\compat
Use copy() instead.
*/
/*!
\fn QImage QImage::scaleWidth(int w) const
\compat
Use scaledToWidth() instead.
*/
/*!
\fn QImage QImage::scaleHeight(int h) const
\compat
Use scaledToHeight() instead.
*/
static QImage smoothScaled(const QImage &source, int w, int h) {
QImage src = source;
if (src.format() == QImage::Format_ARGB32)

View File

@ -754,21 +754,6 @@ QRect QMovie::frameRect() const
return d->frameRect;
}
/*! \fn QImage QMovie::framePixmap() const
Use currentPixmap() instead.
*/
/*! \fn void QMovie::pause()
Use setPaused(true) instead.
*/
/*! \fn void QMovie::unpause()
Use setPaused(false) instead.
*/
/*!
Returns the current frame as a QPixmap.
@ -780,11 +765,6 @@ QPixmap QMovie::currentPixmap() const
return d->currentPixmap;
}
/*! \fn QImage QMovie::frameImage() const
Use currentImage() instead.
*/
/*!
Returns the current frame as a QImage.
@ -806,42 +786,6 @@ bool QMovie::isValid() const
return d->isValid();
}
/*! \fn bool QMovie::running() const
Use state() instead.
*/
/*! \fn bool QMovie::isNull() const
Use isValid() instead.
*/
/*! \fn int QMovie::frameNumber() const
Use currentFrameNumber() instead.
*/
/*! \fn bool QMovie::paused() const
Use state() instead.
*/
/*! \fn bool QMovie::finished() const
Use state() instead.
*/
/*! \fn void QMovie::restart()
Use stop() and start() instead.
*/
/*!
\fn void QMovie::step()
Use jumpToNextFrame() instead.
*/
/*!
Returns the number of frames in the movie.

View File

@ -74,15 +74,15 @@ QList <QWeakPointer<QPlatformCursor> > QPlatformCursorPrivate::instances;
*/
/*!
\fn virtual void QPlatformCursor::changeCursor(QCursor * widgetCursor, QWidget * widget)
\fn virtual void QPlatformCursor::changeCursor(QCursor * windowCursor, QWindow * window)
\brief This method is called by Qt whenever the cursor graphic should be changed.
Implementation of this method is mandatory for a subclass of QPlatformCursor.
\a widgetCursor is a pointer to the QCursor that should be displayed.
\a windowCursor is a pointer to the QCursor that should be displayed.
\a widget is a pointer to the widget currently displayed at QCursor::pos(). Note
\a window is a pointer to the window currently displayed at QCursor::pos(). Note
that this may be 0 if the current position is not occupied by a displayed widget.
\sa QCursor::pos()

View File

@ -85,7 +85,7 @@ public:
// input methods
virtual void pointerEvent(const QMouseEvent & event) { Q_UNUSED(event); }
virtual void changeCursor(QCursor * widgetCursor, QWindow * widget) = 0;
virtual void changeCursor(QCursor * windowCursor, QWindow * window) = 0;
virtual QPoint pos() const;
virtual void setPos(const QPoint &pos);

View File

@ -172,7 +172,7 @@ QPlatformNativeInterface * QPlatformIntegration::nativeInterface() const
/*!
\fn QAbstractEventDispatcher *guiThreadEventDispatcher() const = 0
\fn QAbstractEventDispatcher *QPlatformIntegration::guiThreadEventDispatcher() const = 0
Accessor function for the event dispatcher. The platform plugin should create
an instance of the QAbstractEventDispatcher in its constructor and set it

View File

@ -386,7 +386,7 @@ QRect QScreen::mapBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b, cons
}
/*!
\fn QScreen::currentOrientationChanged()
\fn QScreen::currentOrientationChanged(Qt::ScreenOrientation orientation)
This signal is emitted when the current orientation of the screen
changes. The current orientation is a hint to the application saying

View File

@ -71,29 +71,7 @@ public:
\brief The QBackingStore class provides the drawing area for top-level windows.
*/
/*!
\fn void QBackingStore::beginPaint(const QRegion &region)
This function is called before painting onto the surface begins,
with the \a region in which the painting will occur.
\sa endPaint(), paintDevice()
*/
/*!
\fn void QBackingStore::endPaint(const QRegion &region)
This function is called after painting onto the surface has ended,
with the \a region in which the painting was performed.
\sa beginPaint(), paintDevice()
*/
/*!
\fn void QBackingStore::flush(QWindow *window, const QRegion &region,
const QPoint &offset)
Flushes the given \a region from the specified \a window onto the
screen.
@ -142,11 +120,23 @@ QWindow* QBackingStore::window() const
return d_ptr->window;
}
/*!
This function is called before painting onto the surface begins,
with the \a region in which the painting will occur.
\sa endPaint(), paintDevice()
*/
void QBackingStore::beginPaint(const QRegion &region)
{
d_ptr->platformBackingStore->beginPaint(region);
}
/*!
This function is called after painting onto the surface has ended.
\sa beginPaint(), paintDevice()
*/
void QBackingStore::endPaint()
{
d_ptr->platformBackingStore->endPaint();

View File

@ -951,14 +951,6 @@ bool QBrush::operator==(const QBrush &b) const
}
}
/*!
\fn QBrush::operator const QColor&() const
Returns the brush's color.
Use color() instead.
*/
#ifndef QT_NO_DEBUG_STREAM
/*!
\internal

View File

@ -862,13 +862,6 @@ void QColor::getRgb(int *r, int *g, int *b, int *a) const
*a = ct.argb.alpha >> 8;
}
/*!
\obsolete
\fn void QColor::getRgba(int *r, int *g, int *b, int *a) const
Use getRgb() instead.
*/
/*!
\fn void QColor::setRgbF(qreal r, qreal g, qreal b, qreal a)
@ -921,13 +914,6 @@ void QColor::setRgb(int r, int g, int b, int a)
ct.argb.pad = 0;
}
/*!
\obsolete
\fn void QColor::setRgba(int r, int g, int b, int a)
Use setRgb() instead.
*/
/*!
\fn QRgb QColor::rgba() const
@ -2596,25 +2582,6 @@ QDataStream &operator>>(QDataStream &stream, QColor &color)
the alpha-channel is ignored.
*/
/*!
\fn QColor::QColor(int x, int y, int z, Spec colorSpec)
Use one of the other QColor constructors, or one of the static convenience
functions, instead.
*/
/*!
\fn QColor::rgb(int *r, int *g, int *b) const
Use getRgb() instead.
*/
/*!
\fn QColor::hsv(int *h, int *s, int *v) const
Use getHsv() instead.
*/
/*!
\fn QColor QColor::convertTo(Spec colorSpec) const

View File

@ -938,14 +938,6 @@ QMatrix &QMatrix::rotate(qreal a)
Returns the matrix's determinant.
*/
/*!
\fn QMatrix QMatrix::invert(bool *invertible) const
Returns an inverted copy of this matrix.
Use the inverted() function instead.
*/
/*!
Returns an inverted copy of this matrix.
@ -1165,18 +1157,6 @@ QDebug operator<<(QDebug dbg, const QMatrix &m)
}
#endif
/*!
\fn QRect QMatrix::map(const QRect &rect) const
\compat
Creates and returns a QRect object that is a copy of the given
rectangle, mapped into the coordinate system defined by this
matrix.
Use the mapRect() function instead.
*/
/*!
\fn bool qFuzzyCompare(const QMatrix& m1, const QMatrix& m2)

View File

@ -69,25 +69,6 @@ public:
windows.
*/
/*!
\fn void QPlatformBackingStore::beginPaint(const QRegion &region)
This function is called before painting onto the surface begins,
with the \a region in which the painting will occur.
\sa endPaint(), paintDevice()
*/
/*!
\fn void QPlatformBackingStore::endPaint(const QRegion &region)
This function is called after painting onto the surface has ended,
with the \a region in which the painting was performed.
\sa beginPaint(), paintDevice()
*/
/*!
\fn void QPlatformBackingStore::flush(QWindow *window, const QRegion &region,
const QPoint &offset)
@ -129,10 +110,23 @@ QWindow* QPlatformBackingStore::window() const
return d_ptr->window;
}
/*!
This function is called before painting onto the surface begins,
with the \a region in which the painting will occur.
\sa endPaint(), paintDevice()
*/
void QPlatformBackingStore::beginPaint(const QRegion &)
{
}
/*!
This function is called after painting onto the surface has ended.
\sa beginPaint(), paintDevice()
*/
void QPlatformBackingStore::endPaint()
{
}

View File

@ -227,18 +227,6 @@ bool QFontMetrics::operator ==(const QFontMetrics &other) const
return d == other.d;
}
/*!
\fn bool QFontMetrics::operator!=(const QFontMetrics &other)
Returns true if \a other is not equal to this object; otherwise returns false.
Two font metrics are considered equal if they were constructed
from the same QFont and the paint devices they were constructed
for are considered compatible.
\sa operator==()
*/
/*!
\fn bool QFontMetrics::operator !=(const QFontMetrics &other) const
@ -1098,15 +1086,6 @@ bool QFontMetricsF::operator ==(const QFontMetricsF &other) const
return d == other.d;
}
/*!
\fn bool QFontMetricsF::operator!=(const QFontMetricsF &other)
Returns true if the font metrics are not equal to the \a other font
metrics; otherwise returns false.
\sa operator==()
*/
/*!
\fn bool QFontMetricsF::operator !=(const QFontMetricsF &other) const
\overload
@ -1725,51 +1704,4 @@ qreal QFontMetricsF::lineWidth() const
return engine->lineThickness().toReal();
}
/*!
\fn QSize QFontMetrics::size(int flags, const QString &text, int len,
int tabStops, int *tabArray) const
\compat
Use the size() function in combination with QString::left()
instead.
\oldcode
QSize size = size(flags, str, len, tabstops, tabarray);
\newcode
QSize size = size(flags, str.left(len), tabstops, tabarray);
\endcode
*/
/*!
\fn QRect QFontMetrics::boundingRect(int x, int y, int w, int h, int flags,
const QString& text, int len, int tabStops, int *tabArray) const
\compat
Use the boundingRect() function in combination with
QString::left() and a QRect constructor instead.
\oldcode
QRect rect = boundingRect(x, y, w, h , flags, text, len,
tabStops, tabArray);
\newcode
QRect rect = boundingRect(QRect(x, y, w, h), flags, text.left(len),
tabstops, tabarray);
\endcode
*/
/*!
\fn QRect QFontMetrics::boundingRect(const QString &text, int len) const
\compat
Use the boundingRect() function in combination with
QString::left() instead.
\oldcode
QRect rect = boundingRect(text, len);
\newcode
QRect rect = boundingRect(text.left(len));
\endcode
*/
QT_END_NAMESPACE

View File

@ -97,11 +97,6 @@ void QPlatformFontDatabase::registerQPF2Font(const QByteArray &dataArray, void *
}
/*!
\fn void QPlatformFontDatabase::registerFont(const QString &familyName,
const QString &foundryName, QFont::Weight weight, QFont::Style style,
QFont::Stretch stretch, bool antialiased, bool scalable, int pixelSize,
const QSupportedWritingSystems &writingSystems, void *usrPtr)
Registers a font with the given set of attributes describing the font's
foundry, family name, style and stretch information, pixel size, and
supported writing systems. Additional information about whether the font

View File

@ -1853,11 +1853,6 @@ qint64 QHttp::bytesAvailable() const
return qint64(d->rba.size());
}
/*! \fn qint64 QHttp::readBlock(char *data, quint64 maxlen)
Use read() instead.
*/
/*!
Reads \a maxlen bytes from the response content into \a data and
returns the number of bytes read. Returns -1 if an error occurred.

View File

@ -80,7 +80,6 @@ QAbstractSpinBox *QAccessibleAbstractSpinBox::abstractSpinBox() const
return qobject_cast<QAbstractSpinBox*>(object());
}
/*! \reimp */
QString QAccessibleAbstractSpinBox::text(Text t, int child) const
{
Q_UNUSED(child)
@ -89,7 +88,6 @@ QString QAccessibleAbstractSpinBox::text(Text t, int child) const
return QAccessibleWidget::text(t, 0);
}
/*! \reimp */
bool QAccessibleAbstractSpinBox::doAction(int action, int child, const QVariantList &params)
{
Q_UNUSED(child)
@ -149,17 +147,6 @@ QVariant QAccessibleAbstractSpinBox::invokeMethod(Method method, int child, cons
\ingroup accessibility
*/
/*!
\enum QAccessibleAbstractSpinBox::SpinBoxElements
This enum identifies the components of the spin box.
\value SpinBoxSelf The spin box as a whole
\value Editor The line edit sub-widget.
\value ValueUp The up sub-widget (i.e. the up arrow or + button)
\value ValueDown The down sub-widget (i.e. the down arrow or - button)
*/
/*!
Constructs a QAccessibleSpinWidget object for \a w.
*/
@ -179,7 +166,6 @@ QSpinBox *QAccessibleSpinBox::spinBox() const
return qobject_cast<QSpinBox*>(object());
}
/*! \reimp */
bool QAccessibleSpinBox::doAction(int action, int child, const QVariantList &params)
{
Q_UNUSED(child)
@ -211,7 +197,6 @@ QVariant QAccessibleDoubleSpinBox::invokeMethod(QAccessible::Method, int, const
return QVariant();
}
/*! \reimp */
QString QAccessibleDoubleSpinBox::text(Text textType, int child) const
{
Q_UNUSED(child)
@ -231,19 +216,6 @@ QString QAccessibleDoubleSpinBox::text(Text textType, int child) const
\ingroup accessibility
*/
/*!
\enum QAccessibleScrollBar::ScrollBarElements
This enum identifies the components of the scroll bar.
\value ScrollBarSelf The scroll bar as a whole.
\value LineUp The up arrow button.
\value PageUp The area between the position and the up arrow button.
\value Position The position marking rectangle.
\value PageDown The area between the position and the down arrow button.
\value LineDown The down arrow button.
*/
/*!
Constructs a QAccessibleScrollBar object for \a w.
\a name is propagated to the QAccessibleWidget constructor.
@ -261,7 +233,6 @@ QScrollBar *QAccessibleScrollBar::scrollBar() const
return qobject_cast<QScrollBar*>(object());
}
/*! \reimp */
QString QAccessibleScrollBar::text(Text t, int child) const
{
if (t == Value)
@ -280,17 +251,6 @@ QString QAccessibleScrollBar::text(Text t, int child) const
\ingroup accessibility
*/
/*!
\enum QAccessibleSlider::SliderElements
This enum identifies the components of the slider.
\value SliderSelf The slider as a whole.
\value PageLeft The area to the left of the position.
\value Position The position indicator.
\value PageRight The area to the right of the position.
*/
/*!
Constructs a QAccessibleScrollBar object for \a w.
\a name is propagated to the QAccessibleWidget constructor.
@ -308,7 +268,6 @@ QSlider *QAccessibleSlider::slider() const
return qobject_cast<QSlider*>(object());
}
/*! \reimp */
QString QAccessibleSlider::text(Text t, int child) const
{
if (t == Value)