basic/input/InlineComments.qml

0001 /*
0002  * Header bla
0003  */
0004 import QtQuick 1.1
0005
0006 ///< What happens here?
0007 /**
0008  * A very simple item   ///< How about here?
0009  */
0010 Item {
0011     property int foo  ///< The 'foo' property
0012
0013     signal clicked(int x, int y)  /**< The `clicked` signal */
0014
0015     signal activated  //!< Another signal
0016
0017     function doSomething(arg1, arg2) {   /*!< @param type:string arg1 first argument @param type:int arg2 second argument */
0018         console.log("arg1=" + arg1);
0019     }
0020
0021     /**
0022      * A weirdly documented function.... the inline comment will be stripped. Doxygen would ignore the inline comment anyway.
0023      * @param type:string foo first argument
0024      * @param type:int bar this argument does exist
0025      */
0026     function weirdlyDocumented(foo, bar) {  //!< A weirdly documented function!
0027     }
0028
0029     property string escaped: "a string \n \" \t with escaped chars"  ///< and an inline comment
0030     property string block: "a string with some block {({ ] } chars"  /**< and an inline comment! ***<  //!<  */
0031
0032     function square(arg)    ///< Compute the arg^2. @return type:int the result
0033     {
0034         return arg * arg;
0035     }
0036
0037     ///< Inline comment out of place (should be moved inline in the output)
0038     function refresh() {
0039     }
0040
0041     // Just some regular comment
0042
0043     function reload() ///< Inline comment for a keyword following a regular comment.
0044     {}
0045
0046     /*!  Just for fun...
0047       ///< Inline comment
0048       //!< Inline comment
0049       @param type:string arg1 first argument
0050       @param type:int arg2 second argument
0051       /*!< Inline comment
0052     */
0053     function update(arg1, arg2) { }
0054
0055     Item {
0056     }
0057
0058     property /* foo */ int /* bar */ weirdProperty /* baz */ : /* foo */ 12   ///< and a useless inline comment
0059 }