On 05/19/2015 03:07 PM, Daniel Vetter wrote:
On Tue, May 19, 2015 at 02:05:05PM +0530, Archit Taneja wrote:
Add headerdocs for drm_bridge_add, drm_bridge_remove, drm_bridge_attach and
of_drm_find_bridge.
Signed-off-by: Archit Taneja <architt@xxxxxxxxxxxxxx>
You also need to pull in the kerneldoc into the drm.tmpl DocBook template
to include into the drm docs. You can generate those with
$ make htmldocs -k
-k because right now 802 docs are broken :( Also it'd be awesome if you
could include a short DOC: section to describe the design&goal of
drm_bridge quickly and also include that into the DocBook.
---
drivers/gpu/drm/drm_bridge.c | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
index f70e617..ceb8121 100644
--- a/drivers/gpu/drm/drm_bridge.c
+++ b/drivers/gpu/drm/drm_bridge.c
@@ -31,6 +31,11 @@
static DEFINE_MUTEX(bridge_lock);
static LIST_HEAD(bridge_list);
+/**
+ * drm_bridge_add - add the given bridge to the global bridge list
+ *
+ * @bridge: bridge control structure
For functions which return something it's good to add a Returns: section
describing the semantics of the return codes. Copypasting something
suitable from other kerneldoc is good for consistency ;-)
I wasn't aware of the template stuff. I'll do the required.
Thanks!
Archit
--
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project
_______________________________________________
dri-devel mailing list
dri-devel@xxxxxxxxxxxxxxxxxxxxx
http://lists.freedesktop.org/mailman/listinfo/dri-devel
