[v3,05/23] media: Add KernelDoc documentation for struct media_entity_graph
diff mbox

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

Commit Message

Sakari Ailus Dec. 16, 2015, 1:32 p.m. UTC
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>
---
 include/media/media-entity.h | 9 +++++++++
 1 file changed, 9 insertions(+)

Patch
diff mbox

diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index 4f789a4..3068c30 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;