From: Sakari Ailus <sakari.ailus@iki.fi>
Date: Wed, 16 Dec 2015 13:32:20 +0000 (-0200)
Subject: [media] media: Add KernelDoc documentation for struct media_entity_graph
X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=434257f19ce0a6b635a84882257034ae79d2f274;p=linux-beck.git

[media] media: Add KernelDoc documentation for struct media_entity_graph

KernelDoc doesn't appear to handle anonymous structs defined inside
another gracefully. As the struct is internal to the framework graph walk
algorithm, detailed documentation isn't seen very important.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
---

diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index e8ef40c809ad..edfb6163caa3 100644
--- a/include/media/media-entity.h
+++ b/include/media/media-entity.h
@@ -97,6 +97,15 @@ struct media_entity_enum {
 	int idx_max;
 };
 
+/**
+ * struct media_entity_graph - Media graph traversal state
+ *
+ * @stack:		Graph traversal stack; the stack contains information
+ *			on the path the media entities to be walked and the
+ *			links through which they were reached.
+ * @entities:		Visited entities
+ * @top:		The top of the stack
+ */
 struct media_entity_graph {
 	struct {
 		struct media_entity *entity;