summaryrefslogtreecommitdiffstats
path: root/drivers/base/class.c
diff options
context:
space:
mode:
authorJani Nikula <ext-jani.1.nikula@nokia.com>2010-03-11 17:11:45 +0100
committerGreg Kroah-Hartman <gregkh@suse.de>2010-03-19 15:12:21 +0100
commitf0eae0ed3b7d4182a6b4dd03540a738518ea3163 (patch)
treef7432690b4df967f10643fa82f05f57aecba142f /drivers/base/class.c
parentkobject: documentation: Update to refer to kset-example.c. (diff)
downloadlinux-f0eae0ed3b7d4182a6b4dd03540a738518ea3163.tar.xz
linux-f0eae0ed3b7d4182a6b4dd03540a738518ea3163.zip
driver-core: document ERR_PTR() return values
A number of functions in the driver core return ERR_PTR() values on error. Document this in the kernel-doc of the functions. Signed-off-by: Jani Nikula <ext-jani.1.nikula@nokia.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'drivers/base/class.c')
-rw-r--r--drivers/base/class.c2
1 files changed, 2 insertions, 0 deletions
diff --git a/drivers/base/class.c b/drivers/base/class.c
index 0147f476b8a9..9c6a0d6408e7 100644
--- a/drivers/base/class.c
+++ b/drivers/base/class.c
@@ -219,6 +219,8 @@ static void class_create_release(struct class *cls)
* This is used to create a struct class pointer that can then be used
* in calls to device_create().
*
+ * Returns &struct class pointer on success, or ERR_PTR() on error.
+ *
* Note, the pointer created here is to be destroyed when finished by
* making a call to class_destroy().
*/