From 56f8160af8e89e6981a5f67d23c307dcd1ef0f2a Mon Sep 17 00:00:00 2001
From: Grant Limberg <glimberg@gmail.com>
Date: Sat, 25 Apr 2015 17:29:07 -0700
Subject: generate javadocs for the Java SDK

---
 java/src/com/zerotierone/sdk/NodeStatus.java | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

(limited to 'java/src/com/zerotierone/sdk/NodeStatus.java')

diff --git a/java/src/com/zerotierone/sdk/NodeStatus.java b/java/src/com/zerotierone/sdk/NodeStatus.java
index fdf5284e..163e3056 100644
--- a/java/src/com/zerotierone/sdk/NodeStatus.java
+++ b/java/src/com/zerotierone/sdk/NodeStatus.java
@@ -27,7 +27,7 @@
 
 package com.zerotierone.sdk;
 
-public class NodeStatus {
+public final class NodeStatus {
 	private long address;
 	private String publicIdentity;
 	private String secretIdentity;
@@ -35,18 +35,34 @@ public class NodeStatus {
 
 	private NodeStatus() {}
 
+	/**
+	 * 40-bit ZeroTier address of this node
+	 */
 	public final long getAddres() {
 		return address;
 	}
 
+	/**
+	 * Public identity in string-serialized form (safe to send to others)
+	 *
+	 * <p>This identity will remain valid as long as the node exists.</p>
+	 */
 	public final String getPublicIdentity() {
 		return publicIdentity;
 	}
 
+	/**
+	 * Full identity including secret key in string-serialized form
+	 *
+	 * <p>This identity will remain valid as long as the node exists.</p>
+	 */
 	public final String getSecretIdentity() {
 		return secretIdentity;
 	}
 
+	/**
+	 * True if some kind of connectivity appears available
+	 */
 	public final boolean isOnline() {
 		return online;
 	}
-- 
cgit v1.2.3