Added support for generating javadoc and source archives

Author: amplexus

pom.xml

@@ -51,6 +51,30 @@
           <arguments>-Dgpg.passphrase=${gpg.passphrase}</arguments>
           </configuration>
         </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-source-plugin</artifactId>
+          <executions>
+            <execution>
+              <id>attach-sources</id>
+              <goals>
+                <goal>jar</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <executions>
+            <execution>
+              <id>attach-javadocs</id>
+              <goals>
+                <goal>jar</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
       </plugins>
     </pluginManagement>
   </build>

src/main/java/com/darkprograms/speech/microphone/Microphone.java

@@ -117,7 +117,6 @@ private void initTargetDataLine(){
      *
      * @param audioFile The File to save the audio to
      * @throws LineUnavailableException 
-     * @throws Exception Throws an exception if something went wrong
      */
     public void captureAudioToFile(File audioFile) throws LineUnavailableException {
         setState(CaptureState.STARTING_CAPTURE);
@@ -138,7 +137,6 @@ public void captureAudioToFile(File audioFile) throws LineUnavailableException {
      *
      * @param audioFile The fully path (String) to a file you want to save the audio in
      * @throws LineUnavailableException 
-     * @throws Exception Throws an exception if something went wrong
      */
     public void captureAudioToFile(String audioFile) throws LineUnavailableException {
         File file = new File(audioFile);

src/main/java/com/darkprograms/speech/microphone/MicrophoneAnalyzer.java

@@ -7,7 +7,7 @@
  * Microphone Analyzer class, detects pitch and volume while extending the microphone class.
  * Implemented as a precursor to a Voice Activity Detection (VAD) algorithm.
  * Currently can be used for audio data analysis.
- * Dependencies: FFT.java & Complex.java. Both found in the utility package.
+ * Dependencies: FFT.java and Complex.java. Both found in the utility package.
  * @author Aaron Gokaslan
  ********************************************************************************************/
 

src/main/java/com/darkprograms/speech/recognizer/GSpeechDuplex.java

@@ -472,15 +472,15 @@ private String parseTranscript(String s){
 
 	/**
 	 * Adds GSpeechResponse Listeners that fire when Google sends a response.
-	 * @param The Listeners you want to add
+	 * @param rl The Listeners you want to add
 	 */
 	public synchronized void addResponseListener(GSpeechResponseListener rl){
 		responseListeners.add(rl);
 	}
 
 	/**
 	 * Removes GSpeechResponseListeners that fire when Google sends a response.
-	 * @param rl
+	 * @param rl The Listeners you want to remove
 	 */
 	public synchronized void removeResponseListener(GSpeechResponseListener rl){
 		responseListeners.remove(rl);

src/main/java/com/darkprograms/speech/recognizer/Recognizer.java

@@ -133,7 +133,8 @@ private Recognizer() {
 
     /**
      * Constructor
-     * @param Language
+     * @param language
+     * @param apikey
      */
      @Deprecated
     public Recognizer(String language, String apikey) {
@@ -144,6 +145,7 @@ public Recognizer(String language, String apikey) {
     /**
      * Constructor
      * @param language The Languages class for the language you want to designate
+     * @param apikey
      */
      public Recognizer(Languages language, String apikey){
      	this.language = language.languageCode;
@@ -153,6 +155,7 @@ public Recognizer(Languages language, String apikey){
     /**
      * Constructor
      * @param profanityFilter
+     * @param apikey
      */
     public Recognizer(boolean profanityFilter, String apikey){
     	this.profanityFilter = profanityFilter;
@@ -163,6 +166,7 @@ public Recognizer(boolean profanityFilter, String apikey){
      * Constructor
      * @param language
      * @param profanityFilter
+     * @param apikey
      */
      @Deprecated
     public Recognizer(String language, boolean profanityFilter, String apikey){
@@ -175,6 +179,7 @@ public Recognizer(String language, boolean profanityFilter, String apikey){
      * Constructor
      * @param language
      * @param profanityFilter
+     * @param apikey
      */
      public Recognizer(Languages language, boolean profanityFilter, String apikey){
      	this.language = language.languageCode;
@@ -279,9 +284,9 @@ public GoogleResponse getRecognizedDataForFlac(File flacFile, int maxResults) th
      *
      * @param flacFile FLAC file to recognize
      * @param maxResults the maximum number of results to return in the response
-     * @param samepleRate The sampleRate of the file. Default is 8000.
-     * @return Returns a GoogleResponse, with the response and confidence score
-     * @throws IOException Throws exception if something goes wrong
+     * @param sampleRate The sampleRate of the file. Default is 8000.
+     * @return GoogleResponse with the response and confidence score
+     * @throws IOException if something goes wrong
      */
     public GoogleResponse getRecognizedDataForFlac(File flacFile, int maxResults, int sampleRate) throws IOException{
         String [] response = rawRequest(flacFile, maxResults, sampleRate);
@@ -295,9 +300,9 @@ public GoogleResponse getRecognizedDataForFlac(File flacFile, int maxResults, in
      *
      * @param flacFile FLAC file to recognize
      * @param maxResults the maximum number of results to return in the response
-     * @param samepleRate The sampleRate of the file. Default is 8000.
-     * @return Returns a GoogleResponse, with the response and confidence score
-     * @throws IOException Throws exception if something goes wrong
+     * @param sampleRate The sampleRate of the file. Default is 8000.
+     * @return GoogleResponse, with the response and confidence score
+     * @throws IOException if something goes wrong
      */
     public GoogleResponse getRecognizedDataForFlac(String flacFile, int maxResults, int sampleRate) throws IOException{
     	return getRecognizedDataForFlac(new File(flacFile), maxResults, sampleRate);

src/main/java/com/darkprograms/speech/recognizer/RecognizerChunked.java

@@ -105,7 +105,7 @@ public void getRecognizedDataForFlac(File infile, int sampleRate) throws IOExcep
 
 	/**
 	 * Analyzes the file for speech
-	 * @param infile The file you want to analyze for speech.
+	 * @param inFile The file you want to analyze for speech.
 	 * @param sampleRate The sample rate of the audioFile.
 	 * @throws IOException if something goes wrong reading the file.
 	 */
@@ -279,4 +279,4 @@ private synchronized void fireResponseEvent(GoogleResponse gr){
 		}
 	}
 
-}
+}

src/main/java/com/darkprograms/speech/synthesiser/Synthesiser.java

@@ -231,7 +231,7 @@ private boolean isEndingPunctuation(char input){
 	 * Automatically determines the language of the original text
 	 * @param text represents the text you want to check the language of
 	 * @return the languageCode in ISO-639
-	 * @throws Exception if it cannot complete the request
+	 * @throws IOException if it cannot complete the request
 	 */
 	public String detectLanguage(String text) throws IOException{
 		return GoogleTranslate.detectLanguage(text);

src/main/java/com/darkprograms/speech/synthesiser/SynthesiserV2.java

@@ -276,7 +276,7 @@ private boolean isEndingPunctuation(char input){
 	 * Automatically determines the language of the original text
 	 * @param text represents the text you want to check the language of
 	 * @return the languageCode in ISO-639
-	 * @throws Exception if it cannot complete the request
+	 * @throws IOException if it cannot complete the request
 	 */
 	public String detectLanguage(String text) throws IOException{
 		return GoogleTranslate.detectLanguage(text);
@@ -300,4 +300,4 @@ public InputStream call() throws IOException{
 		}
 	}
 
-}
+}

src/main/java/com/darkprograms/speech/translator/GoogleTranslate.java

@@ -34,7 +34,6 @@ public final class GoogleTranslate { //Class marked as final since all methods a
 	 * Useful for UI Strings
 	 * @param languageCode The ISO639-1 
 	 * @return The language in the user's default language
-	 * @see {@link #detectLanguage}
 	 */
 	public static String getDisplayLanguage(String languageCode){
 		return (new Locale(languageCode)).getDisplayLanguage();