diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-20 19:37:07 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-04-19 07:34:53 +0200 |
commit | 0bc02fd0d61d1e4aed9b39890d28975dff30e822 (patch) | |
tree | e967ab719c7f8df24c35b088bd48e0f5b0942148 /src/corelib/plugin | |
parent | 7f0c130be963de90d1baeb037820b17a4f298700 (diff) |
Doc: Prepare for building modular QtCore docs.
This change fixes most qdoc errors in QtCore. There are about 900 left.
The main thing this change does is moving documentation from qtcore from
/doc/src to /src/corelib/doc.
Other issues resolved are mis-use of qdoc commands.
Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/corelib/plugin')
-rw-r--r-- | src/corelib/plugin/qlibrary.cpp | 10 | ||||
-rw-r--r-- | src/corelib/plugin/qplugin.qdoc | 10 | ||||
-rw-r--r-- | src/corelib/plugin/quuid.cpp | 6 |
3 files changed, 13 insertions, 13 deletions
diff --git a/src/corelib/plugin/qlibrary.cpp b/src/corelib/plugin/qlibrary.cpp index 216e6e1e7c..7bb1ef1263 100644 --- a/src/corelib/plugin/qlibrary.cpp +++ b/src/corelib/plugin/qlibrary.cpp @@ -127,7 +127,7 @@ static QBasicMutex qt_library_mutex; symbol is not defined, the function pointer will be 0 and won't be called. - \snippet doc/src/snippets/code/src_corelib_plugin_qlibrary.cpp 0 + \snippet code/src_corelib_plugin_qlibrary.cpp 0 The symbol must be exported as a C function from the library for resolve() to work. This means that the function must be wrapped in @@ -138,7 +138,7 @@ static QBasicMutex qt_library_mutex; use if you just want to call a function in a library without explicitly loading the library first: - \snippet doc/src/snippets/code/src_corelib_plugin_qlibrary.cpp 1 + \snippet code/src_corelib_plugin_qlibrary.cpp 1 \sa QPluginLoader */ @@ -1118,7 +1118,7 @@ void QLibrary::setFileNameAndVersion(const QString &fileName, const QString &ver not be resolved or if the library could not be loaded. Example: - \snippet doc/src/snippets/code/src_corelib_plugin_qlibrary.cpp 2 + \snippet code/src_corelib_plugin_qlibrary.cpp 2 The symbol must be exported as a C function from the library. This means that the function must be wrapped in an \c{extern "C"} if @@ -1126,11 +1126,11 @@ void QLibrary::setFileNameAndVersion(const QString &fileName, const QString &ver also explicitly export the function from the DLL using the \c{__declspec(dllexport)} compiler directive, for example: - \snippet doc/src/snippets/code/src_corelib_plugin_qlibrary.cpp 3 + \snippet code/src_corelib_plugin_qlibrary.cpp 3 with \c MY_EXPORT defined as - \snippet doc/src/snippets/code/src_corelib_plugin_qlibrary.cpp 4 + \snippet code/src_corelib_plugin_qlibrary.cpp 4 */ QFunctionPointer QLibrary::resolve(const char *symbol) { diff --git a/src/corelib/plugin/qplugin.qdoc b/src/corelib/plugin/qplugin.qdoc index 77069e6dfd..001b0d5932 100644 --- a/src/corelib/plugin/qplugin.qdoc +++ b/src/corelib/plugin/qplugin.qdoc @@ -42,7 +42,7 @@ to the interface class called \a ClassName. The \a Identifier must be unique. For example: - \snippet examples/tools/plugandpaint/interfaces.h 3 + \snippet tools/plugandpaint/interfaces.h 3 This macro is normally used right after the class definition for \a ClassName, in a header file. See the @@ -51,7 +51,7 @@ If you want to use Q_DECLARE_INTERFACE with interface classes declared in a namespace then you have to make sure the Q_DECLARE_INTERFACE is not inside a namespace though. For example: - \snippet doc/src/snippets/code/doc_src_qplugin.cpp 0 + \snippet code/doc_src_qplugin.cpp 0 \sa Q_INTERFACES(), Q_EXPORT_PLUGIN2(), {How to Create Qt Plugins} */ @@ -82,7 +82,7 @@ Example: - \snippet doc/src/snippets/code/doc_src_qplugin.cpp 1 + \snippet code/doc_src_qplugin.cpp 1 See the \l{tools/plugandpaint}{Plug & Paint} example for details. @@ -102,14 +102,14 @@ Example: - \snippet doc/src/snippets/code/doc_src_qplugin.cpp 2 + \snippet code/doc_src_qplugin.cpp 2 Static plugins must also be included by the linker when your application is built. For Qt's predefined plugins, you can use the \c QTPLUGIN to add the required plugins to your build. For example: - \snippet doc/src/snippets/code/doc_src_qplugin.pro 3 + \snippet code/doc_src_qplugin.pro 3 \sa {Static Plugins}, {How to Create Qt Plugins}, {Using qmake} */ diff --git a/src/corelib/plugin/quuid.cpp b/src/corelib/plugin/quuid.cpp index 26032323e0..b1805afd53 100644 --- a/src/corelib/plugin/quuid.cpp +++ b/src/corelib/plugin/quuid.cpp @@ -337,7 +337,7 @@ static QUuid createFromName(const QUuid &ns, const QByteArray &baseData, QCrypto b8. Example: - \snippet doc/src/snippets/code/src_corelib_plugin_quuid.cpp 0 + \snippet code/src_corelib_plugin_quuid.cpp 0 */ #ifndef QT_NO_QUUID_STRING @@ -425,7 +425,7 @@ QUuid::QUuid(const QByteArray &text) /*! \since 5.0 - \fn QUuid::createUuidV3() + \fn QUuid QUuid::createUuidV3(const QUuid &ns, const QByteArray &baseData); This functions returns a new UUID with variant QUuid::DCE and version QUuid::MD5. \a ns is the namespace and \a name is the name as described by RFC 4122. @@ -435,7 +435,7 @@ QUuid::QUuid(const QByteArray &text) /*! \since 5.0 - \fn QUuid::createUuidV5() + \fn QUuid QUuid::createUuidV5(const QUuid &ns, const QByteArray &baseData); This functions returns a new UUID with variant QUuid::DCE and version QUuid::SHA1. \a ns is the namespace and \a name is the name as described by RFC 4122. |