1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# QDoc is a tool that constantly evolves and there may be compatibility issues
# between old and new practices. For that reason, QDoc configuration files in
# the Qt Project includes compat.qdocconf:
include(/usr/share/qt6/doc/global/compat.qdocconf)
# Give the documentation project a title:
project = MsXpertSuite Shared Libraries
moduleheader = developer-documentation.h
# Pass additional include paths to QDoc when parsing C++ code for documentation
# comments.
# includepaths += -I/some/path
# Paths are relative to the directory where qdoc is called, that is:
# /home/rusconi/devel/rewrite-xpertmass/development/doc
includepaths += -I./ \
-I../../../../pappsomspp/development/src/ \
-I../../source/XpertMassCore/includes \
-I../../source/XpertMassGui/includes \
-I/usr/lib/llvm-19/lib/clang/19/include \
-I/usr/lib/gcc/x86_64-linux-gnu/14/include \
-I/usr/include/c++/14 \
-I/usr/include /usr/include/linux \
-I/usr/include/x86_64-linux-gnu/qt6/ \
-I/usr/include/x86_64-linux-gnu/qt6/QtCore \
-I/usr/include/x86_64-linux-gnu/qt6/QtGui \
-I/usr/include/x86_64-linux-gnu/qt6/QtNetwork \
-I/usr/include/x86_64-linux-gnu/qt6/QtSvg \
-I/usr/include/x86_64-linux-gnu/qt6/QtSql \
-I/usr/include/x86_64-linux-gnu/qt6/QtXml \
-I/usr/include/x86_64-linux-gnu/qt6/QtQml
# QDoc needs a lists of file extensions to know which files to process in
# different situations. Uncomment the following include statement to get
# a pre-defined list of file extensions.
#include(fileextensions.qdocconf)
# You can also specify file extensions manually.
headers.fileextensions = "*.h *.hpp"
sources.fileextensions = "*.cpp *.qml *.qdoc"
# The outputdir variable specifies the directory where QDoc places the
# generated documentation.
outputdir = public
# What format to use for generating documentation
outputformats = HTML
# The headerdirs variable specifies the directories that contain the header
# files associated with the .cpp source files used in the documentation.
headerdirs = ../../source/XpertMassCore/includes/MsXpS \
../../source/XpertMassCore/includes/MsXpS/libXpertMassCore \
../../source/XpertMassGui/includes/MsXpS/libXpertMassGui
# The sourcedirs variable specifies the directories that contain the .cpp or
# .qdoc files used in the documentation.
sourcedirs = ./ \
../../source/XpertMassCore/ \
../../source/XpertMassGui/
depends = qtdoc \
qtcore \
qtgui \
qtqml
# apt install qt6-documentation-tools (for /usr/lib/qt6/bin/qdoc)
# apt install qt6-base-doc-html for the qt<lib>.index files
QT_INSTALL_DOCS = /usr/share/qt6/doc/
indexes = \
$QT_INSTALL_DOCS/qtcore/qtcore.index \
$QT_INSTALL_DOCS/qtgui/qtgui.index \
$QT_INSTALL_DOCS/qtwidgets/qtwidgets.index \
$QT_INSTALL_DOCS/qtxml/qtxml.index \
$QT_INSTALL_DOCS/qtsvg/qtsvg.index \
$QT_INSTALL_DOCS/qtsql/qtsql.index \
$QT_INSTALL_DOCS/qtnetwork/qtnetwork.index
# The exampledirs variable specifies the directories that contain the source
# code of the example files.
# exampledirs = ./examples
# The imagedirs variable specifies the directories that contain images used in
# the documentation.
imagedirs = ./images
# Path to the CSS files if you would like to use
HTML.stylesheets = /usr/share/qt6/doc/qtgui/style/offline.css
# The string that actually includes the CSS into documentation file
HTML.headerstyles = "<link rel=\"stylesheet\" \
type=\"text/css\" \
href=\"style/offline.css\"/>\n"
# What to append to every page after header
HTML.postheader = "<font size="12" face=\"helvetica\" >" \
"<table width=\"75%\" border=\"0\"" \
"<tr>" \
"<td>" \
"<a href="index.html">" \
"<img src=\"../images/flying-frog.jpg\" " \
"align=\"left\" width=\"110\" height=\"110\"" \
"</td>" \
"<td>" \
"<large>libXpertMassCore and libXpertMassGui Developer Documentation</large>" \
"</td>" \
"</tr>" \
"</table>" \
"</font>"
# What to append to every page after the content
HTML.footer = "<hr/><p class=\"footer\"><small>Filippo Rusconi</small></p>"
# Set a warning limit. QDoc will exit with a non-zero exit code if it generates
# documentation warnings during the documentation build. Useful for tracking
# down documentation issues.
#warninglimit = 0
#warninglimit.enabled = true
|
