Fixed javadocs

src/main/java/org/red5/annotations/DeclareProtected.java

@@ -36,6 +36,8 @@
 
 	/**
 	 * Permission required to execute method.
+	 * 
+	 * @return permission required
 	 */
 	String permission();
 

src/main/java/org/red5/codec/IVideoStreamCodec.java

@@ -83,7 +83,7 @@ public final static class FrameData {
 		/**
 		 * Makes a copy of the incoming bytes and places them in an IoBuffer. No flip or rewind is performed on the source data.
 		 * 
-		 * @param data
+		 * @param data data
 		 */
 		public void setData(IoBuffer data) {
 			if (frame == null) {

src/main/java/org/red5/compatibility/flex/messaging/messages/Message.java

@@ -72,7 +72,7 @@ public interface Message {
 	/**
 	 * Returns a header value corresponding to the passed header name.
 	 * 
-	 * @param name
+	 * @param name header name
 	 * @return header value
 	 */
 	Object getHeader(String name);
@@ -108,65 +108,65 @@ public interface Message {
 	/**
 	 * Tests whether a header with the passed name exists.
 	 * 
-	 * @param name
+	 * @param name header name
 	 * @return true if header exists, false otherwise
 	 */
 	boolean headerExists(String name);
 
 	/**
 	 * Sets the body of the message.
 	 * 
-	 * @param value
+	 * @param value body
 	 */
 	void setBody(Object value);
 
 	/**
 	 * Sets the client id indicating the client that sent the message.
 	 * 
-	 * @param value
+	 * @param value client id
 	 */
 	void setClientId(String value);
 
 	/**
 	 * Sets the destination that the message targets.
 	 * 
-	 * @param value
+	 * @param value destination
 	 */
 	void setDestination(String value);
 
 	/**
 	 * Sets a header on the message.
 	 * 
-	 * @param name
-	 * @param value
+	 * @param name header name
+	 * @param value header value
 	 */
 	void setHeader(String name, Object value);
 
 	/**
 	 * Sets the headers for the message.
 	 * 
-	 * @param value
+	 * @param values header values
 	 */
-	void setHeaders(Map<String, Object> value);
+	void setHeaders(Map<String, Object> values);
 
 	/**
 	 * Sets the unique message id.
 	 * 
-	 * @param value
+	 * @param value message id
 	 */
 	void setMessageId(String value);
 
 	/**
 	 * Sets the timestamp for the message.
 	 * 
-	 * @param value
+	 * @param value timestamp
 	 */
 	void setTimestamp(long value);
 
 	/**
 	 * Sets the time to live for the message.
 	 * 
-	 * @param value
+	 * @param value ttl
 	 */
 	void setTimeToLive(long value);
 

src/main/java/org/red5/io/amf/Input.java

@@ -54,6 +54,7 @@
  *
  * @author The Red5 Project
  * @author Luke Hubbard, Codegent Ltd ([email protected])
+ * @author Paul Gregoire ([email protected])
  */
 @SuppressWarnings("serial")
 public class Input extends BaseInput implements org.red5.io.object.Input {
@@ -641,36 +642,36 @@ public ByteArray readByteArray(Type target) {
 	}
 
 	/**
-	 * Read Vector<int> object. This is not supported by the AMF0 deserializer.
+	 * Read Vector&lt;int&gt; object. This is not supported by the AMF0 deserializer.
 	 *
-	 * @return	Vector<Integer> object
+	 * @return	Vector&lt;Integer&gt; object
 	 */
 	public Vector<Integer> readVectorInt() {
 		throw new RuntimeException("Vector objects not supported with AMF0");
 	}
 
 	/**
-	 * Read Vector<Long> object. This is not supported by the AMF0 deserializer.
+	 * Read Vector&lt;Long&gt; object. This is not supported by the AMF0 deserializer.
 	 *
-	 * @return	Vector<Long> object
+	 * @return	Vector&lt;Long&gt; object
 	 */
 	public Vector<Long> readVectorUInt() {
 		throw new RuntimeException("Vector objects not supported with AMF0");
 	}
 
 	/**
-	 * Read Vector<Number> object. This is not supported by the AMF0 deserializer.
+	 * Read Vector&lt;Number&gt; object. This is not supported by the AMF0 deserializer.
 	 *
-	 * @return	Vector<Double> object
+	 * @return	Vector&lt;Double&gt; object
 	 */
 	public Vector<Double> readVectorNumber() {
 		throw new RuntimeException("Vector objects not supported with AMF0");
 	}
 
 	/**
-	 * Read Vector<Object> object. This is not supported by the AMF0 deserializer.
+	 * Read Vector&lt;Object&gt; object. This is not supported by the AMF0 deserializer.
 	 *
-	 * @return	Vector<Object> object
+	 * @return	Vector&lt;Object&gt; object
 	 */
 	public Vector<Object> readVectorObject() {
 		throw new RuntimeException("Vector objects not supported with AMF0");

src/main/java/org/red5/io/amf/Output.java

@@ -524,7 +524,7 @@ public void writeVectorObject(Vector<Object> vector) {
 	/**
 	 * Encode string.
 	 *
-	 * @param string
+	 * @param string string to encode
 	 * @return encoded string
 	 */
 	protected static byte[] encodeString(String string) {

src/main/java/org/red5/io/amf3/AMF3.java

@@ -84,7 +84,7 @@ public class AMF3 {
 
 	/**
 	 * XML document marker
-	 * <br />
+	 * <br>
 	 * This is for the legacy XMLDocument type is retained in the language 
 	 * as flash.xml.XMLDocument. Similar to AMF 0, the structure of an 
 	 * XMLDocument needs to be flattened into a string representation for 
@@ -122,22 +122,22 @@ public class AMF3 {
     public static final byte TYPE_BYTEARRAY = 0x0C;
 
     /**
-     * Vector<int> marker
+     * Vector&lt;int&gt; marker
      */
     public static final byte TYPE_VECTOR_INT = 0x0D;
 
     /**
-     * Vector<uint> marker
+     * Vector&lt;uint&gt; marker
      */
     public static final byte TYPE_VECTOR_UINT = 0x0E;
 
     /**
-     * Vector<Number> marker
+     * Vector&lt;Number&gt; marker
      */
     public static final byte TYPE_VECTOR_NUMBER = 0x0F;
 
     /**
-     * Vector<Object> marker
+     * Vector&lt;Object&gt; marker
      */
     public static final byte TYPE_VECTOR_OBJECT = 0x10;
 

src/main/java/org/red5/io/amf3/ByteArray.java

@@ -46,8 +46,8 @@ public class ByteArray implements IDataInput, IDataOutput {
 	/**
 	 * Internal constructor used to create ByteArray during deserialization.
 	 * 
-	 * @param buffer
-	 * @param length
+	 * @param buffer io buffer
+	 * @param length length
 	 */
 	protected ByteArray(IoBuffer buffer, int length) {
 		data = IoBuffer.allocate(length);

src/main/java/org/red5/io/amf3/Input.java

@@ -802,9 +802,9 @@ public ByteArray readByteArray(Type target) {
 	}
 
 	/**
-	 * Read Vector<Integer> object.
+	 * Read Vector&lt;Integer&gt; object.
 	 *
-	 * @return	Vector<Integer> object
+	 * @return	Vector&lt;Integer&gt; object
 	 */
 	@SuppressWarnings("unchecked")
 	public Vector<Integer> readVectorInt() {
@@ -825,9 +825,9 @@ public Vector<Integer> readVectorInt() {
 	}
 
 	/**
-	 * Read Vector<uint> object.
+	 * Read Vector&lt;uint&gt; object.
 	 *
-	 * @return	Vector<Long> object
+	 * @return	Vector&lt;Long&gt; object
 	 */
 	@SuppressWarnings("unchecked")
 	public Vector<Long> readVectorUInt() {
@@ -852,9 +852,9 @@ public Vector<Long> readVectorUInt() {
 	}
 
 	/**
-	 * Read Vector<Number> object.
+	 * Read Vector&lt;Number&gt; object.
 	 *
-	 * @return	Vector<Double> object
+	 * @return	Vector&lt;Double&gt; object
 	 */
 	@SuppressWarnings("unchecked")
 	public Vector<Double> readVectorNumber() {
@@ -879,9 +879,9 @@ public Vector<Double> readVectorNumber() {
 	}
 
 	/**
-	 * Read Vector<Object> object.
+	 * Read Vector&lt;Object&gt; object.
 	 *
-	 * @return	Vector<Object> object
+	 * @return	Vector&lt;Object&gt; object
 	 */
 	@SuppressWarnings("unchecked")
 	public Vector<Object> readVectorObject() {

src/main/java/org/red5/io/amf3/Output.java

@@ -540,9 +540,9 @@ public void writeByteArray(ByteArray array) {
 	}
 
 	/**
-	 * Write a Vector<int>.
+	 * Write a Vector&lt;int&gt;.
 	 * 
-	 * @param vector
+	 * @param vector vector
 	 */
 	@Override
 	public void writeVectorInt(Vector<Integer> vector) {
@@ -571,9 +571,9 @@ public void writeVectorInt(Vector<Integer> vector) {
 	}
 
 	/**
-	 * Write a Vector<uint>.
+	 * Write a Vector&lt;uint&gt;.
 	 * 
-	 * @param vector
+	 * @param vector vector
 	 */
 	@Override
 	public void writeVectorUInt(Vector<Long> vector) {
@@ -596,9 +596,9 @@ public void writeVectorUInt(Vector<Long> vector) {
 	}
 
 	/**
-	 * Write a Vector<Number>.
+	 * Write a Vector&lt;Number&gt;.
 	 * 
-	 * @param vector
+	 * @param vector vector
 	 */
 	@Override
 	public void writeVectorNumber(Vector<Double> vector) {
@@ -618,9 +618,9 @@ public void writeVectorNumber(Vector<Double> vector) {
 	}
 
 	/**
-	 * Write a Vector<Object>.
+	 * Write a Vector&lt;Object&gt;.
 	 * 
-	 * @param vector
+	 * @param vector vector
 	 */
 	@Override
 	public void writeVectorObject(Vector<Object> vector) {

src/main/java/org/red5/io/flv/impl/FLVReader.java

@@ -160,7 +160,7 @@ public FLVReader(File f, boolean generateMetadata) throws IOException {
 	/**
 	 * Creates FLV reader from file channel.
 	 *
-	 * @param channel
+	 * @param channel file channel
 	 * @throws IOException on error
 	 */
 	public FLVReader(FileChannel channel) throws IOException {
@@ -864,7 +864,7 @@ private ITag readTagHeader() {
 	/**
 	 * Returns the last tag's timestamp as the files duration.
 	 * 
-	 * @param flvFile
+	 * @param flvFile FLV file
 	 * @return duration
 	 */
 	public static int getDuration(File flvFile) {

src/main/java/org/red5/io/flv/impl/FLVWriter.java

@@ -984,7 +984,7 @@ public void run() {
 	 * @param audioId audio codec id
 	 * @param videoId video codec id
 	 * @return true if conversion was successful
-	 * @throws InterruptedException 
+	 * @throws InterruptedException Exception on interruption
 	 */
 	public static boolean repair(String path, Integer audioId, Integer videoId) throws InterruptedException {
 		boolean result = false;
@@ -1042,7 +1042,7 @@ public static boolean repair(String path, Integer audioId, Integer videoId) thro
 	 * Exposed to allow repair of flv files if .info and .ser files still exist.
 	 * 
 	 * @param args 0: path to .ser file 1: audio codec id 2: video codec id
-	 * @throws InterruptedException 
+	 * @throws InterruptedException Exception on interruption 
 	 */
 	public static void main(String[] args) throws InterruptedException {
 		if (args == null || args[0] == null) {

src/main/java/org/red5/io/flv/meta/IMetaService.java

@@ -84,7 +84,7 @@ public interface IMetaService {
 	/**
 	 * Media file to be accessed
 	 * 
-	 * @param file
+	 * @param file file
 	 */
 	public void setFile(File file);
 

src/main/java/org/red5/io/flv/meta/MetaCue.java

@@ -25,18 +25,17 @@
  * Cue point is metadata marker used to control and accompany video playback with client-side application
  * events. Each cue point have at least one attribute, timestamp. Timestamp specifies position of cue point in
  * FLV file.
- *
- * <p>Cue points are usually used as event triggers down video flow or navigation points in a file. Cue points are
+ * <br>
+ * Cue points are usually used as event triggers down video flow or navigation points in a file. Cue points are
  * of two types:
  * <ul>
  *  <li>Embedded into FLV or SWF</li>
  *  <li>External, or added on fly (e.g. with FLVPlayback component or ActionScript) on both server-side and client-side.</li>
  * </ul>
- * </p>
- *
- * <p>To add cue point trigger event listener at client-side in Flex/Flash application, use NetStream.onCuePoint event
- * handler.</p>
- *
+ * <br>
+ * To add cue point trigger event listener at client-side in Flex/Flash application, use NetStream.onCuePoint event
+ * handler.
+ * 
  * @author The Red5 Project
  * @author Dominick Accattato ([email protected])
  * @author Luke Hubbard, Codegent Ltd ([email protected])

src/main/java/org/red5/io/m4a/impl/M4AReader.java

@@ -161,6 +161,7 @@ public class M4AReader implements IoConstants, ITagReader {
 	 * Creates M4A reader from file input stream, sets up metadata generation flag.
 	 *
 	 * @param f                    File input stream
+	 * @throws IOException on IO error
 	 */
 	public M4AReader(File f) throws IOException {
 		if (null == f) {

src/main/java/org/red5/io/mp3/impl/MP3Reader.java

@@ -139,7 +139,7 @@ public class MP3Reader implements ITagReader, IKeyFrameDataAnalyzer {
 	 * Creates reader from file input stream
 	 * 
 	 * @param file file input
-	 * @throws IOException 
+	 * @throws IOException on IO error
 	 */
 	public MP3Reader(File file) throws IOException {
 		this.file = file;