AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
709538096c
qt5base-lts/doc/global/macros.qdocconf

63 lines
2.6 KiB
Plaintext
Raw Normal View History

Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.aacute.HTML = "&aacute;"
macro.Aring.HTML = "&Aring;"
macro.aring.HTML = "&aring;"
macro.Auml.HTML = "&Auml;"
macro.author = "\\b{Author:}"
macro.BR.HTML = "<br />"
macro.copyright.HTML = "&copy;"
macro.eacute.HTML = "&eacute;"
macro.gui = "\\b"
qdoc: Fix output of \br command Since the \br was promoted from a macro to a QDoc command, its output has been enclosed in extra paragraph end/start tags, adding to the visible vertical space. This change fixes the issue by not closing the paragraph when QDoc encounters a \br command. Also removes the now-obsolete \br and \hr macros, as they are both proper commands. \BR and \HR substitute macros are kept. Task-number: QTBUG-37361 Change-Id: Iabbefb6e79268419792ccba42386f6342ccd175d Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-08-05 12:59:10 +00:00
macro.HR.HTML = "<hr />"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.iacute.HTML = "&iacute;"
macro.key = "\\b"
Doc: Change instances of '(Mac) OS X' to 'macOS' As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change the occurrences where the Mac platform is discussed to use a macro \macos, which expands to 'macOS'. This helps with adapting to future renaming. Update the instructions on mac-specific Q_OS_* macro usage. Add a \target for the old 'Qt for OS X' topic to keep links working for other documentation modules that try to link with the old name. Change-Id: Id33fb0cd985df702a4ae4efb4c5fd428e77d9b85 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-08-03 10:00:41 +00:00
macro.macos = "macOS"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.menu = "\\b"
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
Documentation: Add \nullptr macro and use where applicable Qt for Python users reading the documentation assume that int(0) can be passed for pointer parameters. Use the newly introduced \nullptr to disambiguate this. In a follow-up step, the \nullptr macro can be defined as None when generating the Qt for Python documentation. Task-number: PYSIDE-903 Change-Id: I3a45f87175a0668ab5f3f95f0aff409f7e3ef027 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-01-10 07:46:52 +00:00
macro.nullptr = "\\c{nullptr}"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.QA = "\\e{Qt Assistant}"
macro.QD = "\\e{Qt Designer}"
macro.QL = "\\e{Qt Linguist}"
CMake: Introduce Q_OBJECT qdoc macro CMake's moc file scanning is rather primitive: It will run moc on any file containing a line that starts with Q_OBJECT (and similar macros). We have four files in QtBase that contain such a macro at the start of the line in a qdoc comment. These four files were excluded from automatic moc handling by cmake, which is not ideal, since this will silently fail when somebody actually adds a Q_OBJECT macro in code. This patch introduces a macro Q_OBJECT for qdoc. This macro will be replaced with Q_OBJECT in the generated documentation. While not nice, at least a failure to use \Q_OBJECT is noticeable: Moc will warn about the file. Change-Id: I829893c1166eee306fe30058d4ea0256affd45ea Reviewed-by: Simon Hausmann <simon.hausmann@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-01-22 09:00:34 +00:00
macro.Q_OBJECT = "Q_OBJECT"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.QQV = "\\e{Qt QML Viewer}"
Doc: Mention exact Qt version the third party attributions apply to We do add, remove or update third party code in minor releases, sometimes even in patch level releases. However, the documentation is supposed to be valid for all existing Qt 5 versions, but doing this for attributions would require infrastructure we don't have. Therefore rather make it explicit which Qt version the attributions apply to. Also mention since when Qt is available under LGPLv3 (starting with Qt 5.4). Task-number: QTBUG-65665 Change-Id: I328b5bf0c143f78ea61aad51f0644c3cbb6dee49 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2018-01-10 15:29:17 +00:00
macro.QtVersion = "$QT_VERSION"
Doc: Add a macro that expands to the Qt version (Major.Minor) Versioning of some QML modules follows the Qt major and minor version exactly. Add a documentation macro that expands to the short version string to help automate the QML plugin documentation. Task-number: QTBUG-67818 Change-Id: I45e7a2a1adfd6a82b828222e49b1d02b7c05897e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2018-09-14 11:08:11 +00:00
macro.QtVer = "$QT_VER"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.param = "\\e"
macro.raisedaster.HTML = "<sup>*</sup>"
macro.rarrow.HTML = "&rarr;"
macro.reg.HTML = "<sup>&reg;</sup>"
macro.return = "Returns"
macro.starslash = "\\c{*/}"
macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "&uuml;"
macro.mdash.HTML = "&mdash;"
macro.pi.HTML = "&Pi;"
Doc: Reintroduce \beginqdoc and \endqdoc macros These macros were previously defined for QDoc manual. This change adds them to global macros.qdocconf so they can be used everywhere. Change-Id: I4fdf5a103ecfb356719951a7d0c6fbd35c887744 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-06 10:11:26 +00:00
macro.beginqdoc.HTML = "/*!"
macro.endqdoc.HTML = "*/"
Doc: Add a custom \borderedimage macro This macro is used similarly to the \image command; it wraps the image in a div with class attribute 'border' that allows additional styling in CSS. Change-Id: I94271074378d79f0e52f1f5a4715a1f84e0254dc Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2016-09-20 12:13:56 +00:00
macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv"
Doc: Adding base macros and other QDoc definitions The module documentation require these definitions. Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 10:39:04 +00:00
macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">"
macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">"
macro.endfloat.HTML = "</div>"
macro.clearfloat.HTML = "<br style=\"clear: both\" />"
macro.emptyspan.HTML = "<span></span>"
Doc: Add macro for embedding YouTube videos This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2017-03-03 09:31:56 +00:00
Doc: Add a macro that returns the minor version Add a global QDoc macro \QtMinorVersion that expands into the minor version of Qt, or more specifically, the minor version contained in the QT_VER environment variable. The main use case for the new macro is to document the QML modules whose minor versions track the minor version of Qt: \qmlmodule QtQuick 2.\QtMinorVersion Task-number: QTBUG-67818 Change-Id: I2b4fcbb18de0f8f95718099309090017c237622f Reviewed-by: Martin Smith <martin.smith@qt.io>
2018-09-09 10:39:53 +00:00
# Expands to the minor version based on the QT_VER environment variable
macro.QtMinorVersion = "$QT_VER"
macro.QtMinorVersion.match = "\\d+\\.(\\d+)"
Doc: Add macro for embedding YouTube videos This macro adds a \youtube <ID> command that embeds a YouTube link into the documentation. The video container scales to a specified percentage of the available horizontal area. It assumes a source aspect ratio of 16:9, but looks acceptable with other ratios. For backends that do not support <iframe> (e.g. QTextBrowser), shows a clickable video thumbnail that open the YouTube link in an external browser window. Unfortunately, QTextBrowser cannot load images from a remote URL, so we need to store a thumbnail image in the .qch file. Change-Id: I3a3a0c5a20dd90e5cec6357ba70a23ee47dbe825 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2017-03-03 09:31:56 +00:00
# Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ
# Also requires a <ID>.jpg thumbnail for offline docs. In .qdocconf, add:
#
# HTML.extraimages += images/dQw4w9WgXcQ.jpg
# qhp.ProjectName.extraFiles += images/dQw4w9WgXcQ.jpg
#
macro.youtube.HTML = "<div class=\"video\">\n<span class=\"vspan\"></span>\n" \
"<iframe src=\"https://www.youtube.com/embed/\1\"" \
"frameborder=\"0\" allowfullscreen>\n" \
"<a href=\"https://www.youtube.com/watch/?v=\1\">\n"\
"<img src=\"images/\1.jpg\"" \
"title=\"Click to play in a browser\" /></a>\n" \
"</iframe></div>\n"
Reference in New Issue Copy Permalink