A few more random documentation fixes

@p replaced by \a, \QD replaced by {Qt Designer}, couple of enums etc.

Change-Id: I315510690bf52e42db519292b4122fa24c73bbc9
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
This commit is contained in:
Shawn Rutledge 2012-08-15 18:40:37 +02:00 committed by Qt by Nokia
parent 70d8e363df
commit 41ca2b4453
4 changed files with 28 additions and 18 deletions

View File

@ -68,7 +68,7 @@
Since the higher-level API is built on top of the lower-level API, Since the higher-level API is built on top of the lower-level API,
some issues are common to both. some issues are common to both.
If you want to provide plugins for use with \QD, see the QtDesigner If you want to provide plugins for use with \l{Qt Designer}, see the QtDesigner
module documentation. module documentation.
Topics: Topics:
@ -193,10 +193,11 @@
The \l{tools/plugandpaint}{Plug & Paint} example documentation The \l{tools/plugandpaint}{Plug & Paint} example documentation
explains this process in detail. See also \l{Creating Custom explains this process in detail. See also \l{Creating Custom
Widgets for Qt Designer} for information about issues that are Widgets for Qt Designer} for information about issues that are
specific to \QD. You can also take a look at the \l{Echo Plugin specific to \l{Qt Designer}. You can also take a look at the
Example} is a more trivial example on how to implement a plugin \l{Echo Plugin Example} which is a more trivial example on
that extends Qt applications. Please note that a QCoreApplication how to implement a plugin that extends Qt applications.
must have been initialized before plugins can be loaded. Please note that a QCoreApplication must have been initialized
before plugins can be loaded.
\section1 Locating Plugins \section1 Locating Plugins

View File

@ -149,6 +149,11 @@
Command+C on the keyboard regardless of the value set, though what is output for Command+C on the keyboard regardless of the value set, though what is output for
QKeySequence::toString(QKeySequence::PortableText) will be different). QKeySequence::toString(QKeySequence::PortableText) will be different).
\value AA_Use96Dpi Assume the screen has a resolution of 96 DPI rather
than using the OS-provided resolution. This will cause font rendering
to be consistent in pixels-per-point across devices rather than
defining 1 point as 1/72 inch.
\value AA_X11InitThreads Calls XInitThreads() as part of the QApplication \value AA_X11InitThreads Calls XInitThreads() as part of the QApplication
construction in order to make Xlib calls thread-safe. This construction in order to make Xlib calls thread-safe. This
attribute must be set before QApplication is constructed. attribute must be set before QApplication is constructed.
@ -2038,6 +2043,10 @@
even the softkeys are invisible i.e. the window is displayed with even the softkeys are invisible i.e. the window is displayed with
\c showFullscreen(). Only supported for Symbian. \c showFullscreen(). Only supported for Symbian.
\value WindowTransparentForInput Informs the window system that this window
is used only for output (displaying something) and does not take input.
Therefore input events should pass through as if it wasn't there.
\value WindowOverridesSystemGestures Informs the window system that this window \value WindowOverridesSystemGestures Informs the window system that this window
implements its own set of gestures and that system level gestures, like for implements its own set of gestures and that system level gestures, like for
instance three-finger desktop switching, should be disabled. instance three-finger desktop switching, should be disabled.
@ -2350,6 +2359,7 @@
\enum Qt::InputMethodQuery \enum Qt::InputMethodQuery
\value ImEnabled The widget accepts input method input. \value ImEnabled The widget accepts input method input.
\value ImMicroFocus \obsolete replaced by \c ImCursorRectangle
\value ImCursorRectangle The rectangle covering the area of the input cursor in widget coordinates. \value ImCursorRectangle The rectangle covering the area of the input cursor in widget coordinates.
\value ImFont The currently used font for text input. \value ImFont The currently used font for text input.
\value ImCursorPosition The logical position of the cursor within the text surrounding the input area \value ImCursorPosition The logical position of the cursor within the text surrounding the input area

View File

@ -135,7 +135,7 @@ void QNetworkAccessCache::clear()
} }
/*! /*!
Appens the entry given by @p key to the end of the linked list. Appends the entry given by \a key to the end of the linked list.
(i.e., makes it the newest entry) (i.e., makes it the newest entry)
*/ */
void QNetworkAccessCache::linkEntry(const QByteArray &key) void QNetworkAccessCache::linkEntry(const QByteArray &key)
@ -164,7 +164,7 @@ void QNetworkAccessCache::linkEntry(const QByteArray &key)
} }
/*! /*!
Removes the entry pointed by @p key from the linked list. Removes the entry pointed by \a key from the linked list.
Returns true if the entry removed was the oldest one. Returns true if the entry removed was the oldest one.
*/ */
bool QNetworkAccessCache::unlinkEntry(const QByteArray &key) bool QNetworkAccessCache::unlinkEntry(const QByteArray &key)

View File

@ -79,10 +79,10 @@ static inline int best(int a, int b, int c)
} }
/** /**
* Opens @p filename and returns content produced as per * Opens \a filename and returns content produced as per
* xmlconf/xmltest/canonxml.html. * xmlconf/xmltest/canonxml.html.
* *
* @p docType is the DOCTYPE name that the returned output should * \a docType is the DOCTYPE name that the returned output should
* have, if it doesn't already have one. * have, if it doesn't already have one.
*/ */
static QByteArray makeCanonical(const QString &filename, static QByteArray makeCanonical(const QString &filename,
@ -197,10 +197,10 @@ static QByteArray makeCanonical(const QString &filename,
} }
/** /**
* @short Returns the lexical QName of the document element in * \brief Returns the lexical QName of the document element in
* @p document. * \a document.
* *
* It is assumed that @p document is a well-formed XML document. * It is assumed that \a document is a well-formed XML document.
*/ */
static QString documentElement(const QByteArray &document) static QString documentElement(const QByteArray &document)
{ {
@ -219,7 +219,7 @@ static QString documentElement(const QByteArray &document)
} }
/** /**
* @short Loads W3C's XML conformance test suite and runs it on QXmlStreamReader. * \brief Loads W3C's XML conformance test suite and runs it on QXmlStreamReader.
* *
* Since this suite is fairly large, it runs the tests sequentially in order to not * Since this suite is fairly large, it runs the tests sequentially in order to not
* have them all loaded into memory at once. In this way, the maximum memory usage stays * have them all loaded into memory at once. In this way, the maximum memory usage stays
@ -228,8 +228,7 @@ static QString documentElement(const QByteArray &document)
* *
* Part of this code is a manual, ad-hoc implementation of xml:base. * Part of this code is a manual, ad-hoc implementation of xml:base.
* *
* @see <a href="http://www.w3.org/XML/Test/">Extensible * See \l {http://www.w3.org/XML/Test/} {Extensible Markup Language (XML) Conformance Test Suites}
* Markup Language (XML) Conformance Test Suites</a>
*/ */
class TestSuiteHandler : public QXmlDefaultHandler class TestSuiteHandler : public QXmlDefaultHandler
{ {
@ -277,7 +276,7 @@ public:
int skipCount; int skipCount;
/** /**
* @p baseURI is the the URI of where the catalog file resides. * \a baseURI is the the URI of where the catalog file resides.
*/ */
TestSuiteHandler(const QUrl &baseURI) : runCount(0), TestSuiteHandler(const QUrl &baseURI) : runCount(0),
skipCount(0) skipCount(0)
@ -690,8 +689,8 @@ QByteArray tst_QXmlStream::readFile(const QString &filename)
reader.setDevice(&file); reader.setDevice(&file);
QByteArray outarray; QByteArray outarray;
QTextStream writer(&outarray); QTextStream writer(&outarray);
// We always want UTF-8, and not what the system picks up. // We always want UTF-8, and not what the system picks up.
writer.setCodec("UTF-8"); writer.setCodec("UTF-8");
while (!reader.atEnd()) { while (!reader.atEnd()) {
reader.readNext(); reader.readNext();