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
|
[](https://travis-ci.org/agateau/doxyqml)
# Goals
Doxyqml turns .qml into pseudo-C++ which Doxygen can then use to generate
documentation.
# Installing
Doxyqml uses the standard Python setup tools, so you can install it with pip:
pip3 install doxyqml
or manually with:
python3 setup.py install
# Telling Doxygen to use Doxyqml
To tell Doxygen about Doxyqml you must make a few changes to your Doxygen file.
1. Add the .qml extension to the `FILTER_PATTERNS` key:
FILTER_PATTERNS = *.qml=doxyqml
Note: On Windows you may need to use the full path of the `doxyqml.py` file
instead. For example if you installed Python 3.5 in `C:\Python35`, use this:
FILTER_PATTERNS = *.qml=C:\Python35\Lib\site-packages\doxyqml\doxyqml.py
2. Add the .qml extension to `FILE_PATTERNS`:
FILE_PATTERNS = *.qml
3. Since Doxygen 1.8.8, you must also add the .qml extension to
`EXTENSION_MAPPING`:
EXTENSION_MAPPING = qml=C++
# Documenting types
QML is partly-typed: functions are untyped, properties and signals are. Doxyqml
provides a way to define types when they are missing or not precise enough.
## Functions
Functions in QML are untyped, but you can define types in the documentation
like this:
/**
* Create a user
* @param type:string firstname User firstname
* @param type:string lastname User lastname
* @param type:int User age
* @return type:User The User object
*/
function createUser(firstname, lastname, age);
## Properties
QML properties are typed, so Doxyqml uses them by default. You can nevertheless
overwrite the type using the same `type:<name>` syntax. This is useful to
document property aliases:
/** type:string The user lastname */
property alias lastname: someObject.text
## Signals
QML signals are typed, so there is no need to use the `type:<name>` syntax to
document their parameters. Using `type:<name>` syntax in signal documentation
will not work: Doxyqml won't strip it out and Doxygen will confuse it with the
parameter name.
/**
* User just logged in
* @param user The user which logged in
*/
signal loggedIn(User user)
|
