[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 e8ef40c809adcc76b40503b87540edf17dba8de5..edfb6163caa3518b974ddb656961bc21b07ec522 100644 (file)
--- 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;