Skip to content

Commit

Permalink
Doc: Adding documentation templates from qtbase
Browse files Browse the repository at this point in the history
Task-number: QTBUG-27293
Change-Id: I4d6983152ea44dd90888c86f1d0956bfca3ac5fe
Reviewed-by: Martin Smith <martin.smith@digia.com>
  • Loading branch information
jeromepasion authored and Martin Smith committed Sep 21, 2012
1 parent d666e19 commit beadb6f
Show file tree
Hide file tree
Showing 3 changed files with 776 additions and 0 deletions.
45 changes: 45 additions & 0 deletions doc/global/qt-html-templates-offline.qdocconf
@@ -0,0 +1,45 @@
#
# W A R N I N G
# -------------
#
# A common HTML template for modules in this repository.
# This template is common among the Qt 5 modules.
#
# A change in this template must be replicated in all of the repositories.
#
# We mean it.
#

HTML.templatedir = ../../../doc

HTML.nobreadcrumbs = "true"

HTML.stylesheets = global/style/offline.css

HTML.headerstyles = \
" <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n"

HTML.endheader = \
"</head>\n" \

HTML.footer = \
"<div class=\"footer\">\n" \
" <p>\n" \
" <acronym title=\"Copyright\">&copy;</acronym> 2012 Nokia Corporation and/or its\n" \
" subsidiaries. Documentation contributions included herein are the copyrights of\n" \
" their respective owners.</p>\n" \
" <br />\n" \
" <p>\n" \
" The documentation provided herein is licensed under the terms of the\n" \
" <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation\n" \
" License version 1.3</a> as published by the Free Software Foundation.</p>\n" \
" <p>\n" \
" Documentation sources may be obtained from <a href=\"http://www.qt-project.org\">\n" \
" www.qt-project.org</a>.</p>\n" \
" <br />\n" \
" <p>\n" \
" Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \
" in Finland and/or other countries worldwide. All other trademarks are property\n" \
" of their respective owners. <a title=\"Privacy Policy\"\n" \
" href=\"http://en.gitorious.org/privacy_policy/\">Privacy Policy</a></p>\n" \
"</div>\n" \
109 changes: 109 additions & 0 deletions doc/global/qt-module-defaults.qdocconf
@@ -0,0 +1,109 @@
#
# W A R N I N G
# -------------
#
# A common template for modules in this repository.
# This template is common among the Qt 5 modules.
#
# A change in this template must be replicated in all of the repositories.
#
# We mean it.
#

codeindent = 1

Cpp.ignoretokens = \
QDBUS_EXPORT \
QT_ASCII_CAST_WARN \
QT_ASCII_CAST_WARN_CONSTRUCTOR \
QT_BEGIN_HEADER \
QT_BEGIN_INCLUDE_NAMESPACE \
QT_BEGIN_NAMESPACE \
QT_BOOTSTRAPPED \
QT_DESIGNER_STATIC \
QT_END_HEADER \
QT_END_INCLUDE_NAMESPACE \
QT_END_NAMESPACE \
QT_FASTCALL \
Q_AUTOTEST_EXPORT \
Q_COMPAT_EXPORT \
Q_CORE_EXPORT \
Q_CORE_EXPORT_INLINE \
Q_DBUS_EXPORT \
Q_DECL_CONSTEXPR \
Q_DECL_NOEXCEPT \
Q_DECL_NOTHROW \
Q_EXPORT \
Q_EXPORT_PLUGIN \
Q_EXPORT_PLUGIN2 \
Q_GADGET \
Q_GUI_EXPORT \
Q_GUI_EXPORT_INLINE \
Q_INLINE_TEMPLATE \
Q_INVOKABLE \
Q_NETWORK_EXPORT \
Q_OPENGL_EXPORT \
Q_OPENVG_EXPORT \
Q_OUTOFLINE_TEMPLATE \
Q_PRINTSUPPORT_EXPORT \
Q_SQL_EXPORT \
Q_SVG_EXPORT \
Q_SCRIPT_EXPORT \
Q_SCRIPTTOOLS_EXPORT \
Q_WIDGETS_EXPORT \
Q_XML_EXPORT \
Q_XMLPATTERNS_EXPORT

Cpp.ignoredirectives = \
__attribute__ \
QT_FORWARD_DECLARE_CLASS \
Q_CLASSINFO \
Q_DECLARE_INTERFACE \
Q_DECLARE_METATYPE \
Q_DECLARE_OPERATORS_FOR_FLAGS \
Q_DECLARE_PRIVATE \
Q_DECLARE_PUBLIC \
Q_DECLARE_PRIVATE_D \
Q_DECLARE_SHARED \
Q_DECLARE_TR_FUNCTIONS \
Q_DECLARE_TYPEINFO \
Q_DISABLE_COPY \
Q_DUMMY_COMPARISON_OPERATOR \
Q_ENUMS \
Q_FLAGS \
Q_INTERFACES \
Q_PRIVATE_PROPERTY

defines = Q_QDOC \
QT_.*_SUPPORT \
QT_.*_LIB \
QT_COMPAT \
QT_KEYPAD_NAVIGATION \
QT_NO_EGL \
Q_OS_.* \
Q_BYTE_ORDER \
QT_DEPRECATED \
QT_DEPRECATED_* \
Q_NO_USING_KEYWORD \
__cplusplus \
Q_COMPILER_INITIALIZER_LISTS

dita.metadata.default.author = Qt Project
dita.metadata.default.permissions = all
dita.metadata.default.publisher = Qt Project
dita.metadata.default.copyryear = 2012
dita.metadata.default.copyrholder = Nokia
dita.metadata.default.audience = programmer

naturallanguage = en_US
outputencoding = UTF-8
sourceencoding = UTF-8

examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml *.css"
examples.imageextensions = "*.png *.jpg *.gif"

headers.fileextensions = "*.ch *.h *.h++ *.hh *.hpp *.hxx"
sources.fileextensions = "*.c++ *.cc *.cpp *.cxx *.mm *.qml *.qdoc"

versionsym = QT_VERSION_STR

0 comments on commit beadb6f

Please sign in to comment.