diff options
| author | Eike Ziller <eike.ziller@qt.io> | 2018-01-25 09:08:14 +0100 |
|---|---|---|
| committer | Eike Ziller <eike.ziller@qt.io> | 2018-01-25 08:36:29 +0000 |
| commit | 7553fd75cf2b8d16134478157cffd3886b21e36d (patch) | |
| tree | e5c597fd98dc2e7ad7864ee17cf219e19807781b | |
| parent | d3e137c20248f6852a91341782011ca58534ed21 (diff) | |
Do not use Qt's documentation macros
Qt 5.10.1 makes changes that would require changes in the Qbs
documentation build. Since it doesn't make sense that changes
in Qt documentation configuration files affect Qbs documentation,
stop using Qt's macros file.
Change-Id: I12bad221dec7204eb2bbabced2cda2af9941315e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
| -rw-r--r-- | doc/config/macros.qdocconf | 54 | ||||
| -rw-r--r-- | doc/config/qbs-project.qdocconf | 1 |
2 files changed, 54 insertions, 1 deletions
diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf index 57ff72747..73f512ecc 100644 --- a/doc/config/macros.qdocconf +++ b/doc/config/macros.qdocconf @@ -1,2 +1,56 @@ macro.QBS = "Qbs" macro.qbsversion = $QBS_VERSION +macro.aacute.HTML = "á" +macro.Aring.HTML = "Å" +macro.aring.HTML = "å" +macro.Auml.HTML = "Ä" +macro.author = "\\b{Author:}" +macro.BR.HTML = "<br />" +macro.copyright.HTML = "©" +macro.eacute.HTML = "é" +macro.gui = "\\b" +macro.HR.HTML = "<hr />" +macro.iacute.HTML = "í" +macro.key = "\\b" +macro.macos = "macOS" +macro.menu = "\\b" +macro.oslash.HTML = "ø" +macro.ouml.HTML = "ö" +macro.QA = "\\e{Qt Assistant}" +macro.QD = "\\e{Qt Designer}" +macro.QL = "\\e{Qt Linguist}" +macro.QQV = "\\e{Qt QML Viewer}" +macro.param = "\\e" +macro.raisedaster.HTML = "<sup>*</sup>" +macro.rarrow.HTML = "→" +macro.reg.HTML = "<sup>®</sup>" +macro.return = "Returns" +macro.starslash = "\\c{*/}" +macro.begincomment = "\\c{/*}" +macro.endcomment = "\\c{*/}" +macro.uuml.HTML = "ü" +macro.mdash.HTML = "—" +macro.pi.HTML = "Π" +macro.beginqdoc.HTML = "/*!" +macro.endqdoc.HTML = "*/" +macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv" + +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>" + +# 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" diff --git a/doc/config/qbs-project.qdocconf b/doc/config/qbs-project.qdocconf index 197a01260..bab672e11 100644 --- a/doc/config/qbs-project.qdocconf +++ b/doc/config/qbs-project.qdocconf @@ -1,4 +1,3 @@ -include($QT_INSTALL_DOCS/global/macros.qdocconf) include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) include($QT_INSTALL_DOCS/global/compat.qdocconf) include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) |