Documentation generation

.gitignore

@@ -1,3 +1,4 @@
 .classpath
 .metadata
 .project
+doc

NoiseJava/src/com/southernstorm/noise/crypto/package-info.java

@@ -0,0 +1,12 @@
+
+/**
+ * Fallback implementations of cryptographic primitives.
+ *
+ * This package provides plain Java implementations of the
+ * cryptographic primitives that Noise requires which do not
+ * normally come with standard JDK's.
+ *
+ * Applications that use Noise won't normally use these classes
+ * directly.
+ */
+package com.southernstorm.noise.crypto;

NoiseJava/src/com/southernstorm/noise/protocol/CipherState.java

@@ -66,7 +66,7 @@ public interface CipherState extends Destroyable {
 	 * The key buffer must contain at least getKeyLength() bytes
 	 * starting at offset.
 	 * 
-	 * @see hasKey()
+	 * @see #hasKey()
 	 */
 	void initializeKey(byte[] key, int offset);
 
@@ -76,7 +76,7 @@ public interface CipherState extends Destroyable {
 	 * @return true if this cipher object has a key; false if the
 	 * key has not yet been set with initializeKey().
 	 * 
-	 * @see initializeKey()
+	 * @see #initializeKey(byte[], int)
 	 */
 	boolean hasKey();
 	

NoiseJava/src/com/southernstorm/noise/protocol/HandshakeState.java

@@ -413,7 +413,10 @@ public class HandshakeState implements Destroyable {
 	 * "XXfallback" handshake pattern without first calling fallback() on a
 	 * previous "IK" handshake.
 	 * 
-	 * @see getAction(), writeMessage(), readMessage(), fallback()
+	 * @see #getAction()
+	 * @see #writeMessage(byte[], int, byte[], int, int)
+	 * @see #readMessage(byte[], int, int, byte[], int)
+	 * @see #fallback()
 	 */
 	public void start()
 	{
@@ -506,7 +509,7 @@ public class HandshakeState implements Destroyable {
 	 * @throws NoSuchAlgorithmException One of the cryptographic algorithms
 	 * that is specified in the new protocolName is not supported.
 	 * 
-	 * @see start()
+	 * @see #start()
 	 */
 	public void fallback() throws NoSuchAlgorithmException
 	{
@@ -611,7 +614,8 @@ public class HandshakeState implements Destroyable {
 	 * @throws ShortBufferException The message buffer does not have
 	 * enough space for the handshake message. 
 	 * 
-	 * @see getAction(), readMessage()
+	 * @see #getAction()
+	 * @see #readMessage(byte[], int, int, byte[], int)
 	 */
 	public int writeMessage(byte[] message, int messageOffset, byte[] payload, int payloadOffset, int payloadLength) throws ShortBufferException
 	{
@@ -762,6 +766,9 @@ public class HandshakeState implements Destroyable {
 	 * 
 	 * @throws AEADBadTagException A MAC value in the message failed
 	 * to verify.
+	 * 
+	 * @see #getAction()
+	 * @see #writeMessage(byte[], int, byte[], int, int)
 	 */
 	public int readMessage(byte[] message, int messageOffset, int messageLength, byte[] payload, int payloadOffset) throws ShortBufferException, AEADBadTagException
 	{

NoiseJava/src/com/southernstorm/noise/protocol/package-info.java

@@ -0,0 +1,7 @@
+
+/**
+ * Provides classes for communicating via the Noise protocol.
+ *
+ * Reference: http://noiseprotocol.org
+ */
+package com.southernstorm.noise.protocol;

README.md

@@ -29,8 +29,8 @@ If you have better implementations of the cryptographic primitives
 available, you can modify the createDH(), createCipher(), and
 createHash() functions in the "Noise" class to integrate your versions.
 
-The [documentation](http://rweather.github.com/noise-java/index.html)
-contains more information on the library, examples, and how to build it.
+The [package documentation](http://rweather.github.com/noise-java/index.html)
+contains more information on the classes in the Noise-Java library.
 
 For more information on this library, to report bugs, to contribute,
 or to suggest improvements, please contact the author Rhys Weatherley via

makedoc.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+rm -rf doc/html
+mkdir -p doc/html
+exec javadoc -sourcepath NoiseJava/src \
+    -subpackages com.southernstorm.noise.protocol \
+    -d doc/html \
+    -windowtitle "Noise-Java" \
+    com.southernstorm.noise.protocol