Doc: Add ability to generate documentation for the module.
-Added targets so that "make docs" will generate the documentation. Change-Id: I16a74d7e15e12df16570f110c7e67a110d53afad Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
This commit is contained in:
Jerome Pasion
committed by
Qt by Nokia
Qt by Nokia
parent
9011296e65
commit
6466ec1bf3
32
doc/config/qtmultimedia-dita.qdocconf
Normal file
32
doc/config/qtmultimedia-dita.qdocconf
Normal file
@@ -0,0 +1,32 @@
|
||||
# Name of the project.
|
||||
project = Qt Multimedia
|
||||
|
||||
# Directories in which to search for files to document and images.
|
||||
# By default set to the root directory of the project for sources
|
||||
# and headers and qdoc will therefore generate output for each file.
|
||||
# Images should be placed in <rootdir>/dic/images and examples in
|
||||
# <rootdir>/examples.
|
||||
# Paths are relative to the location of this file.
|
||||
exampledirs += ../src/examples \
|
||||
../.. \
|
||||
../../examples
|
||||
|
||||
headerdirs += ../src \
|
||||
../../src
|
||||
|
||||
imagedirs += ../src/images \
|
||||
|
||||
sourcedirs += ../src \
|
||||
../../src
|
||||
|
||||
excludedirs +=
|
||||
|
||||
#Do not change the variables after this line unless you know what you are doing.
|
||||
|
||||
outputdir = ../ditaxml
|
||||
outputformats = DITAXML
|
||||
|
||||
examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml"
|
||||
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
|
||||
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
|
||||
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
|
||||
81
doc/config/qtmultimedia.qdocconf
Normal file
81
doc/config/qtmultimedia.qdocconf
Normal file
@@ -0,0 +1,81 @@
|
||||
# Name of the project.
|
||||
project = Qt Multimedia
|
||||
description = Qt Multimedia Documentation
|
||||
|
||||
# Directories in which to search for files to document and images.
|
||||
# By default set to the root directory of the project for sources
|
||||
# and headers and qdoc will therefore generate output for each file.
|
||||
# Images should be placed in <rootdir>/dic/images and examples in
|
||||
# <rootdir>/examples.
|
||||
# Paths are relative to the location of this file.
|
||||
|
||||
exampledirs += ../src/examples \
|
||||
../.. \
|
||||
../../examples
|
||||
|
||||
headerdirs += ../src \
|
||||
../../src
|
||||
|
||||
imagedirs += ../src/images \
|
||||
|
||||
sourcedirs += ../src \
|
||||
../../src
|
||||
|
||||
excludedirs +=
|
||||
|
||||
# The index file contains links to the Qt 5 documentation.
|
||||
# Point to the any .index file to cross link to other projects
|
||||
#indexes = $QT5DOC/doc/html/qt.index
|
||||
|
||||
# The following parameters are for creating a qhp file, the qhelpgenerator
|
||||
# program can convert the qhp file into a qch file which can be opened in
|
||||
# Qt Assistant and/or Qt Creator.
|
||||
|
||||
# Defines the name of the project. You cannot use operators (+, =, -) in
|
||||
# the name. Properties for this project are set using a qhp.<projectname>.property
|
||||
# format.
|
||||
qhp.projects = qtmultimedia
|
||||
|
||||
# Sets the name of the output qhp file.
|
||||
qhp.qtmultimedia.file = qtmultimedia.qhp
|
||||
|
||||
# Namespace for the output file. This namespace is used to distinguish between
|
||||
# different documentation files in Creator/Assistant.
|
||||
qhp.qtmultimedia.namespace = qtmultimedia.500
|
||||
|
||||
# Title for the package, will be the main title for the package in
|
||||
# Assistant/Creator.
|
||||
qhp.qtmultimedia.indexTitle = Qt Multimedia Documentation
|
||||
|
||||
# Extra files to add to the output which are not linked to from anywhere
|
||||
# using a qdoc \l command.
|
||||
qhp.qtmultimedia.extraFiles = style/qtmultimedia.css
|
||||
|
||||
# Only update the name of the project for the next variables.
|
||||
qhp.qtmultimedia.virtualFolder = qdoc
|
||||
qhp.qtmultimedia.subprojects = classes
|
||||
qhp.qtmultimedia.subprojects.classes.title = Classes
|
||||
qhp.qtmultimedia.subprojects.classes.selectors = class fake:headerfile
|
||||
qhp.qtmultimedia.subprojects.classes.sortPages = true
|
||||
|
||||
|
||||
|
||||
# Do NOT change the variables after this line unless you know what you are doing.
|
||||
|
||||
outputdir = ../html
|
||||
outputformats = HTML
|
||||
|
||||
examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml"
|
||||
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
|
||||
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
|
||||
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
|
||||
|
||||
HTML.nobreadcrumbs = "true"
|
||||
|
||||
HTML.templatedir = .
|
||||
HTML.stylesheets = style/qtmultimedia.css
|
||||
|
||||
HTML.headerstyles = " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/qtmultimedia.css\" />\n"
|
||||
HTML.endheader = "</head>\n<body>\n"
|
||||
|
||||
HTML.footer = "<div class=\"footer\">Copyright (c) 2011 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>\n"
|
||||
35
doc/config/qtmultimedia_doc.pri
Normal file
35
doc/config/qtmultimedia_doc.pri
Normal file
@@ -0,0 +1,35 @@
|
||||
|
||||
win32:!win32-g++ {
|
||||
unixstyle = false
|
||||
} else:win32-g++:isEmpty(QMAKE_SH) {
|
||||
unixstyle = false
|
||||
} else {
|
||||
unixstyle = true
|
||||
}
|
||||
|
||||
QDOC = $$QT.core.bins/qdoc3
|
||||
|
||||
ONLINE_CONF = $$PWD/qtmultimedia.qdocconf
|
||||
DITA_CONF = $$PWD/qtmultimedia-dita.qdocconf
|
||||
QCH_CONF = #nothing yet
|
||||
|
||||
$$unixstyle {
|
||||
} else {
|
||||
QDOC = $$replace(QDOC, "qdoc", "qdoc3.exe")
|
||||
ONLINE_CONF = $$replace(ONLINE_CONF, "/", "\\")
|
||||
DITA_DOCS = $$replace(ONLINE_CONF, "/", "\\")
|
||||
}
|
||||
|
||||
# Build rules
|
||||
docs.depends = dita_docs online_docs qch_docs
|
||||
|
||||
online_docs.commands = $$QDOC $$ONLINE_CONF
|
||||
|
||||
dita_docs.commands = $$QDOC $$DITA_CONF
|
||||
|
||||
qch_docs.commands = #no commands yet
|
||||
|
||||
QMAKE_EXTRA_TARGETS += docs dita_docs online_docs qch_docs
|
||||
QMAKE_CLEAN += \
|
||||
"-r $$PWD/../html" \
|
||||
"-r $$PWD/../ditaxml"
|
||||
160
doc/config/style/qtmultimedia.css
Normal file
160
doc/config/style/qtmultimedia.css
Normal file
@@ -0,0 +1,160 @@
|
||||
a:link, a:visited {
|
||||
color: #00732F;
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
body {
|
||||
font: normal 400 14px/1.2 Arial;
|
||||
margin-top: 85px;
|
||||
}
|
||||
|
||||
h1 {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font: 500 20px/1.2 Arial;
|
||||
}
|
||||
|
||||
h3.fn, span.fn {
|
||||
-moz-border-radius: 7px 7px 7px 7px;
|
||||
-webkit-border-radius: 7px 7px 7px 7px;
|
||||
border-radius: 7px 7px 7px 7px;
|
||||
background-color: #F6F6F6;
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #E6E6E6;
|
||||
word-spacing: 3px;
|
||||
padding: 3px 5px;
|
||||
}
|
||||
|
||||
table, pre {
|
||||
-moz-border-radius: 7px 7px 7px 7px;
|
||||
-webkit-border-radius: 7px 7px 7px 7px;
|
||||
border-radius: 7px 7px 7px 7px;
|
||||
background-color: #F6F6F6;
|
||||
border: 1px solid #E6E6E6;
|
||||
border-collapse: separate;
|
||||
font-size: 12px;
|
||||
line-height: 1.2;
|
||||
margin-bottom: 25px;
|
||||
margin-left: 15px;
|
||||
}
|
||||
|
||||
table td {
|
||||
padding: 3px 15px 3px 20px;
|
||||
}
|
||||
|
||||
table tr.even {
|
||||
background-color: white;
|
||||
color: #66666E;
|
||||
}
|
||||
|
||||
table tr.odd {
|
||||
background-color: #F6F6F6;
|
||||
color: #66666E;
|
||||
}
|
||||
|
||||
li {
|
||||
margin-bottom: 10px;
|
||||
padding-left: 12px;
|
||||
}
|
||||
|
||||
.cpp {
|
||||
display: block;
|
||||
margin: 10;
|
||||
overflow: hidden;
|
||||
overflow-x: hidden;
|
||||
overflow-y: hidden;
|
||||
padding: 20px 0 20px 0;
|
||||
}
|
||||
|
||||
.footer {
|
||||
margin-top: 50px;
|
||||
}
|
||||
|
||||
.memItemLeft {
|
||||
padding-right: 3px;
|
||||
}
|
||||
|
||||
.memItemRight {
|
||||
padding: 3px 15px 3px 0;
|
||||
}
|
||||
|
||||
.qml {
|
||||
display: block;
|
||||
margin: 10;
|
||||
overflow: hidden;
|
||||
overflow-x: hidden;
|
||||
overflow-y: hidden;
|
||||
padding: 20px 0 20px 0;
|
||||
}
|
||||
|
||||
.qmldefault {
|
||||
padding-left: 5px;
|
||||
float: right;
|
||||
color: red;
|
||||
}
|
||||
|
||||
.qmlreadonly {
|
||||
padding-left: 5px;
|
||||
float: right;
|
||||
color: #254117;
|
||||
}
|
||||
|
||||
.rightAlign {
|
||||
padding: 3px 5px 3px 10px;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.title {
|
||||
background-color: white;
|
||||
color: #44A51C;
|
||||
font-family: Verdana;
|
||||
font-size: 35px;
|
||||
font-weight: normal;
|
||||
left: 0;
|
||||
padding-bottom: 5px;
|
||||
padding-left: 16px;
|
||||
padding-top: 20px;
|
||||
position: absolute;
|
||||
right: 0;
|
||||
top: 0;
|
||||
}
|
||||
|
||||
.toc {
|
||||
float: right;
|
||||
-moz-border-radius: 7px 7px 7px 7px;
|
||||
-webkit-border-radius: 7px 7px 7px 7px;
|
||||
border-radius: 7px 7px 7px 7px;
|
||||
background-color: #F6F6F6;
|
||||
border: 1px solid #DDD;
|
||||
margin: 0 20px 10px 10px;
|
||||
padding: 20px 15px 20px 20px;
|
||||
height: auto;
|
||||
width: 200px;
|
||||
}
|
||||
/* offset the child sections */
|
||||
.toc .level2 {
|
||||
margin-left: 15px;
|
||||
}
|
||||
.toc .level3 {
|
||||
margin-left: 30px;
|
||||
}
|
||||
.toc .level4 {
|
||||
margin-left: 40px;
|
||||
}
|
||||
|
||||
/* modify the TOC layouts */
|
||||
div.toc ul {
|
||||
padding-left: 20px;
|
||||
}
|
||||
div.toc li {
|
||||
padding-left: 4px;
|
||||
}
|
||||
/* Remove the border around images*/
|
||||
a img
|
||||
{
|
||||
border:none;
|
||||
}
|
||||
@@ -20,3 +20,4 @@ SUBDIRS += module_qtmultimedia_src \
|
||||
module_qtmultimedia_examples \
|
||||
module_qtmultimedia_tests \
|
||||
|
||||
include(doc/config/qtmultimedia_doc.pri)
|
||||
|
||||
Reference in New Issue
Block a user