diff --git a/doc/news/_preparation_next_release.md b/doc/news/_preparation_next_release.md index bd769f4ef44..870d38983f5 100644 --- a/doc/news/_preparation_next_release.md +++ b/doc/news/_preparation_next_release.md @@ -184,9 +184,9 @@ you up to date with the multi-language support provided by Elektra. Until internal `KeySet` iterator support has been dropped form native library, `Elektra::ksRewind` is being retained while also being annotated as 'deprecated for removal'. The reason is, that we still need to rewind a `KeySet` before passing it to a native plugin via `NativePlugin::set`, `NativePlugin::get` or `NativePlugin::error`. _(@tucek)_ Furthermore `Elektra::ksPop` and `KeySet::pop` have been removed and `KeySet::remove` has been introduced as replacment. - Until internal `KeySet` iterator support has been dropped form native library, `Elektra::ksRewind` is being retained while also being annotated as 'depricated for removal'. The reason is, that we still need to rewind a `KeySet` before passing it to a native plugin via `NativePlugin::set`, `NativePlugin::get` or `NativePlugin::error`. _(@tucek)_ +Until internal `KeySet` iterator support has been dropped form native library, `Elektra::ksRewind` is being retained while also being annotated as 'depricated for removal'. The reason is, that we still need to rewind a `KeySet` before passing it to a native plugin via `NativePlugin::set`, `NativePlugin::get` or `NativePlugin::error`. _(@tucek)_ - Further more `Elektra::ksPop` and `KeySet::pop` have been removed and `KeySet::remove` has been introduced as replacment. _(Michael Tucek)_ +Further more `Elektra::ksPop` and `KeySet::pop` have been removed and `KeySet::remove` has been introduced as replacment. _(Michael Tucek)_ - Migrated to Gradle project _(Michael Tucek)_ diff --git a/src/bindings/jna/java-shared.gradle b/src/bindings/jna/java-shared.gradle index ac2f5d886fd..546238ebd35 100644 --- a/src/bindings/jna/java-shared.gradle +++ b/src/bindings/jna/java-shared.gradle @@ -57,7 +57,10 @@ tasks.named('javadoc').configure { } // TODO #3754 reactivate: fail on warnings and warn about non-compliant javadoc syntax - //options.addStringOption('Xwerror', '-Xdoclint:all') + //options.addStringOption('Xwerror', '-quiet') + //options.addStringOption('Xdoclint:all', '-quiet') + options.addStringOption('Xdoclint:-missing', '-quiet') + options.addStringOption('Xdoclint:all', '-quiet') } javadoc { diff --git a/src/bindings/jna/libelektra/src/main/java/org/libelektra/Elektra.java b/src/bindings/jna/libelektra/src/main/java/org/libelektra/Elektra.java index cb112bcfafd..65a0d220ca7 100644 --- a/src/bindings/jna/libelektra/src/main/java/org/libelektra/Elektra.java +++ b/src/bindings/jna/libelektra/src/main/java/org/libelektra/Elektra.java @@ -14,7 +14,7 @@ public interface Elektra extends Library { /** * Singleton instance of the native library proxy. */ - Elektra INSTANCE = Native.loadLibrary("elektra-kdb", Elektra.class); + Elektra INSTANCE = Native.loadLibrary ("elektra-kdb", Elektra.class); // KDB methods -------------------------------------------------------------- @@ -47,8 +47,7 @@ public interface Elektra extends Library { *
  • {@code null} on failure
  • * */ - @Nullable - Pointer kdbOpen(@Nullable Pointer contractKeySet, Pointer errorKey); + @Nullable Pointer kdbOpen (@Nullable Pointer contractKeySet, Pointer errorKey); /** * Closes the session with the Key database.
    @@ -71,7 +70,7 @@ public interface Elektra extends Library { *
  • {@code -1} on {@code null} pointer passed
  • * */ - int kdbClose(Pointer handle, Pointer errorKey); + int kdbClose (Pointer handle, Pointer errorKey); /** * Retrieve keys in an atomic and universal way.
    @@ -136,7 +135,7 @@ public interface Elektra extends Library { * information in the {@code parentKey} and {@code returnKeySet} left * unchanged. */ - int kdbGet(Pointer handle, Pointer returnKeySet, Pointer parentKey); + int kdbGet (Pointer handle, Pointer returnKeySet, Pointer parentKey); /** * Set keys in an atomic and universal way.
    @@ -192,12 +191,12 @@ public interface Elektra extends Library { * in KDB, an error will be set on {@code parentKey} if possible * */ - int kdbSet(Pointer handle, Pointer keySet, Pointer parentKey); + int kdbSet (Pointer handle, Pointer keySet, Pointer parentKey); /** * Sets up a contract for use with {@link #kdbOpen(Pointer, Pointer) kdbOpen()} * that configures the {@code gopts} plugin. - * + * * @param contractKeySet {@link Pointer} to a valid {@code KeySet} into which * the contract will be written. * @param argsSize Size of the {@code args} data. @@ -222,64 +221,66 @@ public interface Elektra extends Library { *
  • {@code -1} on {@code null} pointer passed
  • * */ - int elektraGOptsContractFromStrings(Pointer contractKeySet, long argsSize, String args, long envSize, String env, - Pointer parentKey, @Nullable Pointer goptsConfigKeySet); + int elektraGOptsContractFromStrings (Pointer contractKeySet, long argsSize, String args, long envSize, String env, + Pointer parentKey, @Nullable Pointer goptsConfigKeySet); // Key methods -------------------------------------------------------------- /** * Enumeration of argument flags for {@link Elektra#keyNew(String, Object...)}. */ - enum KeyNewArgumentFlags { + enum KeyNewArgumentFlags + { /** * Used as a parameter terminator to {@link Elektra#keyNew(String, Object...)} */ - KEY_END(0), + KEY_END (0), /** * Flag for the key name */ - KEY_NAME(1), + KEY_NAME (1), /** * Flag for the key data */ - KEY_VALUE(1 << 1), + KEY_VALUE (1 << 1), /** * Flag for the key comment */ - KEY_COMMENT(1 << 3), + KEY_COMMENT (1 << 3), /** * Flag if the key is binary */ - KEY_BINARY(1 << 4), + KEY_BINARY (1 << 4), /** * Flag for maximum size to limit value */ - KEY_SIZE(1 << 11), + KEY_SIZE (1 << 11), /** * Flag for metadata */ - KEY_META(1 << 15); + KEY_META (1 << 15); private final Integer value; /** * @return Integer value recognized by the native library. - */ - public Integer getValue() { + */ + public Integer getValue () + { return value; } - private KeyNewArgumentFlags(int value) { - this.value = Integer.valueOf(value); + private KeyNewArgumentFlags (int value) + { + this.value = Integer.valueOf (value); } - } /** @@ -287,145 +288,148 @@ private KeyNewArgumentFlags(int value) { *
    * For examples and further particularities, please see the documentation of the * native library: TODO #3754 link to C API documentation - * + * * @see #keyDel(Pointer) keyDel() * @see KeyNewArgumentFlags - * + * * @param name A valid name to the key, or {@code null} to get a simple * initialized, but really empty, object. - * @param args Argument flags, each followed by a corresponding value, if appropriate. - * @return