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
|
/*
* Header bla
*/
import QtQuick 1.1
///< What happens here?
/**
* A very simple item ///< How about here?
*/
Item {
property int foo ///< The 'foo' property
signal clicked(int x, int y) /**< The `clicked` signal */
signal activated //!< Another signal
function doSomething(arg1, arg2) { /*!< @param type:string arg1 first argument @param type:int arg2 second argument */
console.log("arg1=" + arg1);
}
/**
* A weirdly documented function.... the inline comment will be stripped. Doxygen would ignore the inline comment anyway.
* @param type:string foo first argument
* @param type:int bar this argument does exist
*/
function weirdlyDocumented(foo, bar) { //!< A weirdly documented function!
}
property string escaped: "a string \n \" \t with escaped chars" ///< and an inline comment
property string block: "a string with some block {({ ] } chars" /**< and an inline comment! ***< //!< */
function square(arg) ///< Compute the arg^2. @return type:int the result
{
return arg * arg;
}
///< Inline comment out of place (should be moved inline in the output)
function refresh() {
}
// Just some regular comment
function reload() ///< Inline comment for a keyword following a regular comment.
{}
/*! Just for fun...
///< Inline comment
//!< Inline comment
@param type:string arg1 first argument
@param type:int arg2 second argument
/*!< Inline comment
*/
function update(arg1, arg2) { }
Item {
}
property /* foo */ int /* bar */ weirdProperty /* baz */ : /* foo */ 12 ///< and a useless inline comment
}
|
