summaryrefslogtreecommitdiff
path: root/src/java
diff options
context:
space:
mode:
authorMax Kellermann <max@musicpd.org>2018-09-06 20:04:46 +0200
committerMax Kellermann <max@musicpd.org>2018-09-06 20:04:46 +0200
commitab678787f4ead4aa660078acf821fa87f8f8f127 (patch)
tree8522a86bb514bf1da5af032a9318bfb43a7eacfd /src/java
parent23556585ca4b17c826da5a115f01d7291dd1cacd (diff)
java/Ref: API doc line breaks
Diffstat (limited to 'src/java')
-rw-r--r--src/java/Ref.hxx26
1 files changed, 14 insertions, 12 deletions
diff --git a/src/java/Ref.hxx b/src/java/Ref.hxx
index 78e3b7763..686907477 100644
--- a/src/java/Ref.hxx
+++ b/src/java/Ref.hxx
@@ -85,8 +85,8 @@ namespace Java {
public:
/**
- * Constructs an uninitialized object. The method set() must be
- * called before it is destructed.
+ * Constructs an uninitialized object. The method
+ * set() must be called before it is destructed.
*/
GlobalRef() = default;
@@ -107,8 +107,9 @@ namespace Java {
GlobalRef &operator=(const GlobalRef &other) = delete;
/**
- * Sets the object, ignoring the previous value. This is only
- * allowed once after the default constructor was used.
+ * Sets the object, ignoring the previous value. This
+ * is only allowed once after the default constructor
+ * was used.
*/
void Set(JNIEnv *env, T _value) noexcept {
assert(_value != nullptr);
@@ -127,10 +128,10 @@ namespace Java {
/**
* Container for a global reference to a JNI object that gets
- * initialised and deinitialised explicitly. Since there is no
- * implicit initialisation in the default constructor, this is a
- * trivial C++ class. It should only be used for global variables
- * that are implicitly initialised with zeroes.
+ * initialised and deinitialised explicitly. Since there is
+ * no implicit initialisation in the default constructor, this
+ * is a trivial C++ class. It should only be used for global
+ * variables that are implicitly initialised with zeroes.
*/
template<typename T>
class TrivialRef {
@@ -147,8 +148,8 @@ namespace Java {
}
/**
- * Obtain a global reference on the specified object and store it.
- * This object must not be set already.
+ * Obtain a global reference on the specified object
+ * and store it. This object must not be set already.
*/
void Set(JNIEnv *env, T _value) noexcept {
assert(value == nullptr);
@@ -168,8 +169,9 @@ namespace Java {
}
/**
- * Release the global reference and clear this object. It is
- * allowed to call this method without ever calling Set().
+ * Release the global reference and clear this object.
+ * It is allowed to call this method without ever
+ * calling Set().
*/
void ClearOptional(JNIEnv *env) noexcept {
if (value != nullptr)