diff options
author | Topi Reinio <topi.reinio@digia.com> | 2014-08-26 09:57:09 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2014-09-10 10:44:00 +0200 |
commit | a0127da1fd1a5146044b74daff4bfa4208868681 (patch) | |
tree | 94825deb2ec83260713e609c6928a313528015dc /doc/src | |
parent | 79c0a29deae622239cd0d57dfbe8c10d4e5be68b (diff) | |
download | qt-creator-a0127da1fd1a5146044b74daff4bfa4208868681.tar.gz |
Doc: Clear a number of documentation warnings
QDoc gets confused about the contents of doc_src_plugins.qdoc,
mistaking some of its code for QDoc commands.
To work around this problem, change the file to be a qdoc
include file, wrap the code blocks with \badcode, and
refer to them using \include.
Using \badcode will also turn off code highlighting and
autolinking, something that is not desired for these code
snippets.
Change-Id: I6c3b65ef098ec6f6f06892d78a3abb38e0d28ca3
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/widgets/doc_src_plugins.qdocinc | 106 | ||||
-rw-r--r-- | doc/src/widgets/qtdesigner-plugins.qdoc | 12 |
2 files changed, 112 insertions, 6 deletions
diff --git a/doc/src/widgets/doc_src_plugins.qdocinc b/doc/src/widgets/doc_src_plugins.qdocinc new file mode 100644 index 0000000000..df8f684412 --- /dev/null +++ b/doc/src/widgets/doc_src_plugins.qdocinc @@ -0,0 +1,106 @@ +/**************************************************************************** +** +** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** +****************************************************************************/ + +//! [0] +\badcode +otool -L /Developer/Applications/Qt/plugins/designer/libqwt_designer_plugin.dylib +\endcode +//! [0] + + +//! [1] +\badcode +/Developer/Applications/Qt/plugins/designer/libqwt_designer_plugin.dylib: + libqwt_designer_plugin.dylib (compatibility version 0.0.0, current version 0.0.0) + libqwt.5.dylib (compatibility version 5.2.0, current version 5.2.1) + QtDesigner.framework/Versions/4/QtDesigner (compatibility version 4.6.0, current version 4.6.2) + QtScript.framework/Versions/4/QtScript (compatibility version 4.6.0, current version 4.6.2) + QtXml.framework/Versions/4/QtXml (compatibility version 4.6.0, current version 4.6.2) + QtGui.framework/Versions/4/QtGui (compatibility version 4.6.0, current version 4.6.2) + QtCore.framework/Versions/4/QtCore (compatibility version 4.6.0, current version 4.6.2) + /usr/lib/libstdc++.6.dylib (compatibility version 7.0.0, current version 7.9.0) + /usr/lib/libgcc_s.1.dylib (compatibility version 1.0.0, current version 438.0.0) + /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 125.0.1) +\endcode +//! [1] + +//! [2] +\badcode +otool -L /usr/local/qwt-5.2.1/lib/libqwt.5.dylib +\endcode +//! [2] + + +//! [3] +\badcode +/usr/local/qwt-5.2.1/lib/libqwt.5.dylib: + libqwt.5.dylib (compatibility version 5.2.0, current version 5.2.1) + QtGui.framework/Versions/4/QtGui (compatibility version 4.6.0, current version 4.6.2) + QtCore.framework/Versions/4/QtCore (compatibility version 4.6.0, current version 4.6.2) + /usr/lib/libstdc++.6.dylib (compatibility version 7.0.0, current version 7.9.0) + /usr/lib/libgcc_s.1.dylib (compatibility version 1.0.0, current version 438.0.0) + /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 125.0.1) +\endcode +//! [3] + + +//! [4] +\badcode +sudo cp /Developer/Applications/Qt/plugins/designer/libqwt_designer_plugin.dylib \ + /Developer/Applications/Qt/Qt\ Creator.app/Contents/MacOS/designer +sudo cp -R /usr/local/qwt-5.2.1/lib/* \ + /Developer/Applications/Qt/Qt\ Creator.app/Contents/Frameworks/ +\endcode +//! [4] + + +//! [5] +\badcode +cd /Developer/Applications/Qt/Qt\ Creator.app/Contents/MacOS/designer +sudo install_name_tool -change + QtCore.framework/Versions/4/QtCore \ + @executable_path/../Frameworks/libQtCore.4.dylib \ + libqwt_designer_plugin.dylib +sudo install_name_tool -change QtGui.framework/Versions/4/QtGui \ + @executable_path/../Frameworks/libQtGui.4.dylib \ + libqwt_designer_plugin.dylib +sudo install_name_tool -change QtXml.framework/Versions/4/QtXml \ + @executable_path/../Frameworks/libQtXml.4.dylib \ + libqwt_designer_plugin.dylib +sudo install_name_tool -change QtScript.framework/Versions/4/QtScript \ + @executable_path/../Frameworks/libQtScript.4.dylib \ + libqwt_designer_plugin.dylib +sudo install_name_tool -change QtDesigner.framework/Versions/4/QtDesigner \ + @executable_path/../Frameworks/libQtDesigner.4.dylib \ + libqwt_designer_plugin.dylib +sudo install_name_tool -change libqwt.5.dylib \ + @executable_path/../Frameworks/libqwt.5.dylib \ + libqwt_designer_plugin.dylib + +cd /Developer/Applications/Qt/Qt\ Creator.app/Contents/Frameworks +sudo install_name_tool -change \ + QtCore.framework/Versions/4/QtCore \ + @executable_path/../Frameworks/libQtCore.4.dylib \ + libqwt.5.2.1.dylib +sudo install_name_tool -change \ + QtGui.framework/Versions/4/QtGui \ + @executable_path/../Frameworks/libQtGui.4.dylib \ + libqwt.5.2.1.dylib +\endcode +//! [5] + diff --git a/doc/src/widgets/qtdesigner-plugins.qdoc b/doc/src/widgets/qtdesigner-plugins.qdoc index accf991c19..2d4a786d70 100644 --- a/doc/src/widgets/qtdesigner-plugins.qdoc +++ b/doc/src/widgets/qtdesigner-plugins.qdoc @@ -85,13 +85,13 @@ \li To check the paths used in the Qwt library, enter the following \c otool command: - \snippet doc_src_plugins.qdoc 0 + \include doc_src_plugins.qdocinc 0 The output for Qwt 5.2.1 indicates that the plugin uses Qt core libraries (QtDesigner, QtScript, QtXml, QtGui and QtCore) and libqwt.5.dylib: - \snippet doc_src_plugins.qdoc 1 + \include doc_src_plugins.qdocinc 1 \li You must copy the \QD plugin and the Qwt library files to the @@ -108,21 +108,21 @@ Enter the following commands: - \snippet doc_src_plugins.qdoc 4 + \include doc_src_plugins.qdocinc 4 \li Enter the following \c otool command to check the libraries that are used by the Qwt library: - \snippet doc_src_plugins.qdoc 2 + \include doc_src_plugins.qdocinc 2 The command returns the following output: - \snippet doc_src_plugins.qdoc 3 + \include doc_src_plugins.qdocinc 3 \li Enter the following \c install_name_tool command to fix the references of the libraries: - \snippet doc_src_plugins.qdoc 5 + \include doc_src_plugins.qdocinc 5 \endlist |