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/Peer.java | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

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

diff --git a/java/src/com/zerotierone/sdk/Peer.java b/java/src/com/zerotierone/sdk/Peer.java
index cd2268b4..60b9ff4b 100644
--- a/java/src/com/zerotierone/sdk/Peer.java
+++ b/java/src/com/zerotierone/sdk/Peer.java
@@ -29,7 +29,10 @@ package com.zerotierone.sdk;
 
 import java.util.ArrayList;
 
-public class Peer {
+/**
+ * Peer status result
+ */
+public final class Peer {
     private long address;
     private long lastUnicastFrame;
     private long lastMulticastFrame;
@@ -42,38 +45,65 @@ public class Peer {
 
     private Peer() {}
 
+    /**
+     * ZeroTier address (40 bits)
+     */
     public final long address() {
         return address;
     }
 
+    /**
+     * Time we last received a unicast frame from this peer
+     */
     public final long lastUnicastFrame() {
         return lastUnicastFrame;
     }
 
+    /**
+     * Time we last received a multicast rame from this peer
+     */
     public final long lastMulticastFrame() {
         return lastMulticastFrame;
     }
 
+    /**
+     * Remote major version or -1 if not known
+     */
     public final int versionMajor() {
         return versionMajor;
     }
 
+    /**
+     * Remote minor version or -1 if not known
+     */
     public final int versionMinor() {
         return versionMinor;
     }
 
+    /**
+     * Remote revision or -1 if not known
+     */
     public final int versionRev() {
         return versionRev;
     }
 
+    /**
+     * Last measured latency in milliseconds or zero if unknown
+     */
     public final int latency() {
         return latency;
     }
 
+    /**
+     * What trust hierarchy role does this device have?
+     */
     public final PeerRole role() {
         return role;
     }
 
+    /**
+     * Known network paths to peer
+     */
     public final ArrayList<PhysicalPeerPath> paths() {
         return paths;
     }
-- 
cgit v1.2.3