[v2,05/22] media: Add KernelDoc documentation for struct media_entity_graph
diff mbox

Message ID 1448824823-10372-6-git-send-email-sakari.ailus@iki.fi
State New
Headers show

Commit Message

Sakari Ailus Nov. 29, 2015, 7:20 p.m. UTC
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 include/media/media-entity.h | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Mauro Carvalho Chehab Dec. 12, 2015, 3:15 p.m. UTC | #1
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;
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch
diff mbox

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
+ * @top:		The top of the stack
+ */
 struct media_entity_graph {
 	struct {
 		struct media_entity *entity;