oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

java/Ref: API doc line breaks

Browse Source
This commit is contained in:
Max Kellermann 2018-09-06 20:04:46 +02:00
parent 23556585ca
commit ab678787f4
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/java/Ref.hxx
View File

@ -85,8 +85,8 @@ namespace Java {
public: public:
/** /**
* Constructs an uninitialized object. The method set() must be * Constructs an uninitialized object. The method
* called before it is destructed. * set() must be called before it is destructed.
*/ */
GlobalRef() = default; GlobalRef() = default;
@ -107,8 +107,9 @@ namespace Java {
GlobalRef &operator=(const GlobalRef &other) = delete; GlobalRef &operator=(const GlobalRef &other) = delete;
/** /**
* Sets the object, ignoring the previous value. This is only * Sets the object, ignoring the previous value. This
* allowed once after the default constructor was used. * is only allowed once after the default constructor
* was used.
*/ */
void Set(JNIEnv *env, T _value) noexcept { void Set(JNIEnv *env, T _value) noexcept {
assert(_value != nullptr); assert(_value != nullptr);
@ -127,10 +128,10 @@ namespace Java {
/** /**
* Container for a global reference to a JNI object that gets * Container for a global reference to a JNI object that gets
* initialised and deinitialised explicitly. Since there is no * initialised and deinitialised explicitly. Since there is
* implicit initialisation in the default constructor, this is a * no implicit initialisation in the default constructor, this
* trivial C++ class. It should only be used for global variables * is a trivial C++ class. It should only be used for global
* that are implicitly initialised with zeroes. * variables that are implicitly initialised with zeroes.
*/ */
template<typename T> template<typename T>
class TrivialRef { class TrivialRef {
@ -147,8 +148,8 @@ namespace Java {
} }
/** /**
* Obtain a global reference on the specified object and store it. * Obtain a global reference on the specified object
* This object must not be set already. * and store it. This object must not be set already.
*/ */
void Set(JNIEnv *env, T _value) noexcept { void Set(JNIEnv *env, T _value) noexcept {
assert(value == nullptr); assert(value == nullptr);
@ -168,8 +169,9 @@ namespace Java {
} }
/** /**
* Release the global reference and clear this object. It is * Release the global reference and clear this object.
* allowed to call this method without ever calling Set(). * It is allowed to call this method without ever
* calling Set().
*/ */
void ClearOptional(JNIEnv *env) noexcept { void ClearOptional(JNIEnv *env) noexcept {
if (value != nullptr) if (value != nullptr)