Differential D4375 Diff 10809 file_templates/common/class_method_declaration_apidox_cpp.txt

Changeset View

Standalone View

		1		{# Template for api dox in front of class method declaration #}
		2		{% with method.arguments as arguments %}
		3		{# standard four spaces indentation to match context #}
		4		/**
		5		{% if method.isConstructor %}
		6		* {% if not arguments %}Default constructor{% else %}Constructor{% endif %}
		7		{% elif method.isDestructor %}
		8		* Destructor
		9		{% else %}
		10		* @todo write docs
		11		{% endif %}
		12		{# and > or, so we go here if arguments or (returntype and not constructor/destructor) #}
		13		{% if arguments or method.returnType and not method.isConstructor and not method.isDestructor %}
		14		*
		15		{% endif %}
		16		{% for argument in arguments %}
		17		* @param {{ argument.name }} TODO
		18		{% endfor %}
		19		{% if method.returnType and not method.isConstructor and not method.isDestructor %}
		20		* @return TODO
		21		{% endif %}
		22		*/
		23		{% endwith %}