file_templates/common/class_method_declaration_apidox_cpp.txt

0001 {# Template for api dox in front of class method declaration #}
0002 {% load kdev_filters %}
0003 {% with method.arguments as arguments %}
0004     {# standard four spaces indentation to match context #}
0005     /**
0006     {% if method.isConstructor %}
0007         {% if not arguments %}
0008      * Default constructor
0009         {% else %}
0010             {% with arguments|first as argFirst %}
0011             {% if arguments|length == 1 and argFirst.type == method.name|arg_type %}
0012      * Copy constructor
0013             {% else %}
0014      * Constructor
0015             {% endif %}
0016             {% endwith %}
0017         {% endif %}
0018     {% elif method.isDestructor %}
0019      * Destructor
0020     {% elif "operator=" == method.name %}
0021      * Assignment operator
0022     {% else %}
0023      * @todo write docs
0024     {% endif %}
0025     {# and > or, so we go here if arguments or (returntype and not constructor/destructor) #}
0026     {% if arguments  or  method.returnType and not method.isConstructor and not method.isDestructor %}
0027      *
0028     {% endif %}
0029     {% for argument in arguments %}
0030      * @param {{ argument.name }} TODO
0031     {% endfor %}
0032     {% if method.returnType and not method.isConstructor and not method.isDestructor %}
0033      * @return TODO
0034     {% endif %}
0035      */
0036 {% endwith %}