Lines Matching refs:description

73    * function_name() - Brief description of function.
79    * A longer description, with more discussion of the function function_name()
84    * The longer description may have multiple paragraphs.
91    * The return value description can also have multiple paragraphs, and should
95 The brief description following the function name may span multiple lines, and
96 ends with an argument description, a blank comment line, or the end of the
103 the short function description.  Do not leave a blank line between the
104 function description and the arguments, nor between the arguments.
106 Each ``@argument:`` description may span multiple lines.
110    If the ``@argument`` description has multiple lines, the continuation
111    of the description should start at the same column as the previous line::
113       * @argument: some long description
119       *		some long description
122 If a function has a variable number of arguments, its description should
125       * @...: description
184    * struct struct_name - Brief description.
197 The brief description following the structure name may span multiple
198 lines, and ends with a member description, a blank comment line, or the
205 as function parameters; they immediately succeed the short description
208 Inside a ``struct`` or ``union`` description, you can use the ``private:`` and
219    * struct my_struct - short description
224    * Longer description
295    * struct foo - Brief description.
307          * Here, the member description may contain several paragraphs.
311                 /** @foobar: Single line description. */
329    * typedef type_name - Brief description.
337    * typedef type_name - Brief description.
338    * @arg1: description of arg1
339    * @arg2: description of arg2
354    * var var_name - Brief description.
375    * define object_name - Brief description.
436   a function description.