Lines Matching refs:description
70 * function_name() - Brief description of function.
76 * A longer description, with more discussion of the function function_name()
81 * The longer description may have multiple paragraphs.
88 * The return value description can also have multiple paragraphs, and should
92 The brief description following the function name may span multiple lines, and
93 ends with an argument description, a blank comment line, or the end of the
100 the short function description. Do not leave a blank line between the
101 function description and the arguments, nor between the arguments.
103 Each ``@argument:`` description may span multiple lines.
107 If the ``@argument`` description has multiple lines, the continuation
108 of the description should start at the same column as the previous line::
110 * @argument: some long description
116 * some long description
119 If a function has a variable number of arguments, its description should
122 * @...: description
180 * struct struct_name - Brief description.
193 The brief description following the structure name may span multiple
194 lines, and ends with a member description, a blank comment line, or the
201 as function parameters; they immediately succeed the short description
204 Inside a struct or union description, you can use the ``private:`` and
215 * struct my_struct - short description
220 * Longer description
291 * struct foo - Brief description.
303 * Here, the member description may contain several paragraphs.
307 /** @foobar: Single line description. */
325 * typedef type_name - Brief description.
333 * typedef type_name - Brief description.
334 * @arg1: description of arg1
335 * @arg2: description of arg2
359 * define object_name - Brief description.
416 a function description.