Re: [PATCH v2 05/22] media: Add KernelDoc documentation for struct media_entity_graph

[Mauro Carvalho Chehab <mchehab@osg.samsung.com>]

Em Sun, 29 Nov 2015 21:20:06 +0200
Sakari Ailus <sakari.ailus@iki.fi> escreveu:

> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>  include/media/media-entity.h | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2601bb0..8fd888f 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -95,6 +95,14 @@ struct media_entity_enum {
>  	int idx_max;
>  };
>  
> +/*
> + * struct media_entity_graph - Media graph traversal state
> + *
> + * @stack.entity:	Media entity in the stack
> + * @stack.link:		Link through which the entity was reached
> + * @entities:		Visited entities

The above is ok, but I guess you could get something better at the
documentation, for example using, instead:
	@stack.@entity

This requires some testing with ./scripts/kernel-doc, though.

> + * @top:		The top of the stack
> + */
>  struct media_entity_graph {
>  	struct {
>  		struct media_entity *entity;