Messages in this thread | | | Date | Wed, 20 Jan 2021 13:40:48 +0200 | From | Andy Shevchenko <> | Subject | Re: [PATCH v3] software_node: Add kernel-doc comments to exported symbols |
| |
On Wed, Jan 20, 2021 at 11:11:47AM +0000, Daniel Scally wrote: > On 20/01/2021 10:35, Sakari Ailus wrote: > > On Wed, Jan 20, 2021 at 12:03:39AM +0000, Daniel Scally wrote:
> >> +/** > >> + * fwnode_create_software_node() - Create and register a new software_node > >> + * @properties: NULL terminated array of properties to assign to the new node > >> + * @parent: Pointer to a &struct fwnode_handle to assign as parent to the new > >> + * node > >> + * > >> + * NOTE: The pointer passed as @parent **must** be to a firmware node handle > >> + * that was created by registering a software node, meaning is_software_node() > >> + * must return true when passed that pointer. > >> + * > >> + * This function creates a new instance of &struct software_node, assigns it a > >> + * copy of the given array of properties and registers it as a new fwnode_handle. > >> + * Freeing of the allocated memory when the fwnode_handle is no longer needed is > >> + * handled via software_node_release() and does not need to be done separately. > > Please wrap all lines over 80 unless there's a reason to keep them longer.
> Apologies; I'll cat | awk for lines over the limit from now on rather > than half-arsing it.
In Vim, for example, you may set the threshold and it will wrap it for you. Also, taking into account famous *useless use of cat*, you may use `fold` or `fmt`
> >> + * > >> + * Returns: > >> + * * fwnode_handle * - On success > >> + * * -EINVAL - When @parent is not associated with a software_node > >> + * * -ENOMEM - When memory allocation fails > >> + * * -Other - Propagated errors from sub-functions > >> + */
-- With Best Regards, Andy Shevchenko
| |