Skip to content
This repository was archived by the owner on Mar 4, 2023. It is now read-only.

Commit 5c54297

Browse files
committed
fixup qml doc generation
1 parent 510e36b commit 5c54297

File tree

7 files changed

+259
-232
lines changed

7 files changed

+259
-232
lines changed

doc/Doxyfile

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
311311
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
312312
# the files are not read by doxygen.
313313

314-
EXTENSION_MAPPING = qmldoc=C++
314+
EXTENSION_MAPPING = qml=C++
315315

316316
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
317317
# according to the Markdown format, which allows for more readable
@@ -811,6 +811,7 @@ WARN_LOGFILE =
811811
# Note: If this tag is empty the current directory is searched.
812812

813813
INPUT = ../src \
814+
../src/imports/mvvmquick \
814815
.
815816

816817
# This tag can be used to specify the character encoding of the source files
@@ -879,7 +880,7 @@ FILE_PATTERNS = *.c \
879880
*.as \
880881
*.js \
881882
*.qdoc \
882-
*.qmldoc
883+
*.qml
883884

884885
# The RECURSIVE tag can be used to specify whether or not subdirectories should
885886
# be searched for input files as well.
@@ -895,7 +896,6 @@ RECURSIVE = YES
895896
# run.
896897

897898
EXCLUDE = ../src/3rdparty \
898-
../src/imports/ \
899899
../src/plugins
900900

901901
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
@@ -917,7 +917,9 @@ EXCLUDE_PATTERNS = moc_* \
917917
qrc_* \
918918
tst_* \
919919
*_p.* \
920-
*.cpp
920+
*.cpp \
921+
*/src/mvvmquick/*.qml \
922+
*/src/mvvmdatasyncquick/*.qml
921923

922924
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
923925
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -929,6 +931,10 @@ EXCLUDE_PATTERNS = moc_* \
929931
# exclude all test directories use the pattern */test/*
930932

931933
EXCLUDE_SYMBOLS = QtMvvm::__helpertypes \
934+
QtMvvmCoreDeclarativeModule \
935+
QtMvvmQuickDeclarativeModule \
936+
QtMvvmDataSyncCoreDeclarativeModule \
937+
QtMvvmDataSyncQuickDeclarativeModule \
932938
\
933939
QAbstractAspect \
934940
QAndroidActivityResultReceiver \
@@ -945,7 +951,22 @@ EXCLUDE_SYMBOLS = QtMvvm::__helpertypes \
945951
QNodeCreatedChangeBase \
946952
QPaintEngineEx \
947953
QQmlExtensionInterface \
948-
QTechniqueFilter
954+
QTechniqueFilter \
955+
\
956+
ApplicationWindow \
957+
Dialog \
958+
Drawer \
959+
FileChooser \
960+
Item \
961+
Label \
962+
ListView \
963+
Page \
964+
ProgressBar \
965+
QtObject \
966+
RoundButton \
967+
StackView \
968+
ToolBar \
969+
ToolButton
949970

950971
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
951972
# that contain example code fragments that are included (see the \include
@@ -1006,7 +1027,7 @@ INPUT_FILTER =
10061027
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
10071028
# properly processed by doxygen.
10081029

1009-
FILTER_PATTERNS = *.qmldoc=doxyqml
1030+
FILTER_PATTERNS = *.qml=doxyqml
10101031

10111032
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
10121033
# INPUT_FILTER) will also be used to filter the input files that are used for
@@ -2128,7 +2149,8 @@ INCLUDE_FILE_PATTERNS = *.h \
21282149
# recursively expanded use the := operator instead of the = operator.
21292150
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
21302151

2131-
PREDEFINED = __cplusplus=201402L
2152+
PREDEFINED = __cplusplus=201402L \
2153+
DOXYGEN_RUN
21322154

21332155
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
21342156
# tag can be used to specify a list of macro names that should be expanded. The

doc/doc.pro

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ OTHER_FILES += Doxyfile \
55
doxme.py \
66
../README.md \
77
*.dox \
8-
qmldoc/mvvmcore/* \
98
snippets/*.cpp \
109
images/*
1110

doc/qmldoc/mvvmcore/Message.h

Lines changed: 0 additions & 53 deletions
This file was deleted.

doc/qmldoc/mvvmcore/MvvmBinding.h

Lines changed: 0 additions & 119 deletions
This file was deleted.

doc/qtmvvm.dox

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The following list shows which classes belong to which Qt module, in alphabetica
1919
- SettingsViewModel
2020
- ViewModel
2121
- All Methods not explicitly listed
22+
- QML import: @ref de::skycoder42::QtMvvm::Core "de.skycoder42.QtMvvm.Core"
2223
- QtMvvmWidgets:
2324
- InputWidgetFactory
2425
- IPresentingView
@@ -27,15 +28,50 @@ The following list shows which classes belong to which Qt module, in alphabetica
2728
- QtMvvmQuick:
2829
- InputViewFactory
2930
- QuickPresenter
31+
- QML import: @ref de::skycoder42::QtMvvm::Quick "de.skycoder42.QtMvvm.Quick"
3032
- QtMvvmDataSyncCore:
3133
- AccountModel
3234
- DataSyncViewModel
3335
- ExchangeDevicesModel
3436
- NetworkExchangeViewModel
37+
- QML import: @ref de::skycoder42::QtMvvm::DataSync::Core "de.skycoder42.QtMvvm.DataSync.Core"
3538
- QtMvvmDataSyncWidgets:
3639
- DataSyncWindow
3740
- NetworkExchangeWindow
3841
- registerDataSyncWidgets()
3942
- QtMvvmDataSyncQuick:
4043
- registerDataSyncQuick()
44+
- QML import: @ref de::skycoder42::QtMvvm::DataSync::Quick "de.skycoder42.QtMvvm.DataSync.Quick"
45+
*/
46+
47+
/*!
48+
@namespace de::skycoder42::QtMvvm::Core
49+
@brief The QML import for the QtMvvmCore QML module
50+
51+
<b>Current Version</b><br/>
52+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
53+
*/
54+
55+
/*!
56+
@namespace de::skycoder42::QtMvvm::Quick
57+
@brief The QML import for the QtMvvmQuick QML module
58+
59+
<b>Current Version</b><br/>
60+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
61+
*/
62+
63+
/*!
64+
@namespace de::skycoder42::QtMvvm::DataSync::Core
65+
@brief The QML import for the QtMvvmDataSyncCore QML module
66+
67+
<b>Current Version</b><br/>
68+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
69+
*/
70+
71+
/*!
72+
@namespace de::skycoder42::QtMvvm::DataSync::Quick
73+
@brief The QML import for the QtMvvmDataSyncQuick QML module
74+
75+
<b>Current Version</b><br/>
76+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.0
4177
*/

0 commit comments

Comments
 (0)