aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorFrancisco Jerez <[email protected]>2014-04-04 14:06:11 +0200
committerFrancisco Jerez <[email protected]>2014-04-05 12:18:29 +0200
commit4ccff1499c956b51f18710c7308cbce883f64cd9 (patch)
tree9727f6f21d56f6ead2e3fe03d9ad67e2968077b1 /src
parent489cb0b2d1b057e0e2e64ee30435cb93b9167fdb (diff)
clover: Document that the *obj*() helpers already take care of object validation.
Diffstat (limited to 'src')
-rw-r--r--src/gallium/state_trackers/clover/core/object.hpp10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/gallium/state_trackers/clover/core/object.hpp b/src/gallium/state_trackers/clover/core/object.hpp
index b8b3da81eb7..697565c807a 100644
--- a/src/gallium/state_trackers/clover/core/object.hpp
+++ b/src/gallium/state_trackers/clover/core/object.hpp
@@ -113,7 +113,8 @@ namespace clover {
}
///
- /// Get a Clover object from an API object.
+ /// Get a Clover object from an API object performing object
+ /// validation.
///
/// \a T can either be the Clover object type to return or a \a tag
/// object to select some special validation behavior by means of a
@@ -131,8 +132,8 @@ namespace clover {
}
///
- /// Get a pointer to a Clover object from an API object. Returns
- /// \c NULL if its argument is \c NULL.
+ /// Get a pointer to a Clover object from an API object performing
+ /// object validation. Returns \c NULL if its argument is \c NULL.
///
/// \sa obj
///
@@ -165,7 +166,8 @@ namespace clover {
}
///
- /// Get a range of Clover objects from a range of API objects.
+ /// Get a range of Clover objects from a range of API objects
+ /// performing object validation.
///
/// \sa obj
///