diff options
| author | Henning Baldersheim <balder@yahoo-inc.com> | 2022-04-27 15:58:14 +0200 |
|---|---|---|
| committer | Henning Baldersheim <balder@yahoo-inc.com> | 2022-04-27 15:58:14 +0200 |
| commit | fe299db9989afada29d8f7efa88a42ad7ddb3e36 (patch) | |
| tree | bf3bed6e44d9c120d6b59d85c8f9b5231f7e2df5 /vespajlib | |
| parent | 2b0994346361e2e292dc390abd21129ba527f39f (diff) | |
Add some basic class comments.
Diffstat (limited to 'vespajlib')
5 files changed, 25 insertions, 0 deletions
diff --git a/vespajlib/src/main/java/com/yahoo/nativec/GLibcVersion.java b/vespajlib/src/main/java/com/yahoo/nativec/GLibcVersion.java index 67ae30c84f5..2dfa4f6d11b 100644 --- a/vespajlib/src/main/java/com/yahoo/nativec/GLibcVersion.java +++ b/vespajlib/src/main/java/com/yahoo/nativec/GLibcVersion.java @@ -1,5 +1,10 @@ package com.yahoo.nativec; +/** + * Gives access to the C library version. + * + * @author baldersheim + */ public class GLibcVersion { private final static Throwable initException = NativeC.loadLibrary(GLibcVersion.class); public static Throwable init() { diff --git a/vespajlib/src/main/java/com/yahoo/nativec/MallInfo.java b/vespajlib/src/main/java/com/yahoo/nativec/MallInfo.java index d7da1b2d8c2..eda6c7d1af7 100644 --- a/vespajlib/src/main/java/com/yahoo/nativec/MallInfo.java +++ b/vespajlib/src/main/java/com/yahoo/nativec/MallInfo.java @@ -2,6 +2,11 @@ package com.yahoo.nativec; import com.sun.jna.Structure; +/** + * Gives access to the information provided by the C library mallinfo() function. + * + * @author baldersheim + */ public class MallInfo extends NativeHeap { private final static Throwable initException = NativeC.loadLibrary(MallInfo.class); public static Throwable init() { diff --git a/vespajlib/src/main/java/com/yahoo/nativec/MallInfo2.java b/vespajlib/src/main/java/com/yahoo/nativec/MallInfo2.java index 9e94bad8d40..ea735046843 100644 --- a/vespajlib/src/main/java/com/yahoo/nativec/MallInfo2.java +++ b/vespajlib/src/main/java/com/yahoo/nativec/MallInfo2.java @@ -2,6 +2,11 @@ package com.yahoo.nativec; import com.sun.jna.Structure; +/** + * Gives access to the information provided by the C library mallinfo2() function. + * + * @author baldersheim + */ public class MallInfo2 extends NativeHeap { private final static Throwable initException = NativeC.loadLibrary(MallInfo2.class); public static Throwable init() { diff --git a/vespajlib/src/main/java/com/yahoo/nativec/NativeHeap.java b/vespajlib/src/main/java/com/yahoo/nativec/NativeHeap.java index 929ebdd1737..ddff2e33230 100644 --- a/vespajlib/src/main/java/com/yahoo/nativec/NativeHeap.java +++ b/vespajlib/src/main/java/com/yahoo/nativec/NativeHeap.java @@ -2,6 +2,11 @@ package com.yahoo.nativec; import com.sun.jna.Platform; +/** + * Represents the native C heap if accessible + * + * @author baldersheim + */ public class NativeHeap { public long usedSize() { return 0; } public long totalSize() { return 0; } diff --git a/vespajlib/src/main/java/com/yahoo/nativec/PosixFAdvise.java b/vespajlib/src/main/java/com/yahoo/nativec/PosixFAdvise.java index 3e2c26d2ef2..0fdcbca5f14 100644 --- a/vespajlib/src/main/java/com/yahoo/nativec/PosixFAdvise.java +++ b/vespajlib/src/main/java/com/yahoo/nativec/PosixFAdvise.java @@ -2,6 +2,11 @@ package com.yahoo.nativec; import com.sun.jna.LastErrorException; +/** + * Gives access to the C library posix_fadvise() function. + * + * @author baldersheim + */ public class PosixFAdvise { public static final int POSIX_FADV_DONTNEED = 4; // See /usr/include/linux/fadvise.h private final static Throwable initException = NativeC.loadLibrary(PosixFAdvise.class); |