Merge pull request #27 from bgarciaentornos/fixJavadocs

Fix JavaDocs warnings and errors

src/main/java/edu/ksu/canvas/interfaces/CommunicationChannelWriter.java

@@ -10,11 +10,11 @@ public interface CommunicationChannelWriter extends CanvasWriter<CommunicationCh
 
     /**
      * Adds a communication channel to a Canvas user.
-     * @param cc The communication channel to create. Must contain user ID and address.
+     * @param options The communication channel to create. Must contain user ID and address.
      * @return The created communication channel object if creation was successful
      * @throws IOException When there is an error communicating with Canvas
      */
-    Optional<CommunicationChannel> createCommunicationChannel(CreateCommunicationChannelOptions ccco) throws IOException;
+    Optional<CommunicationChannel> createCommunicationChannel(CreateCommunicationChannelOptions options) throws IOException;
 
     /**
      * Delete a communication channel from Canvas

src/main/java/edu/ksu/canvas/interfaces/CourseWriter.java

@@ -56,9 +56,10 @@ public interface CourseWriter extends CanvasWriter<Course, CourseWriter> {
     /**
      * Start a file upload to a course.
      *
-     * @param options
-     * @throws IOException
-     * @return
+     * @param courseId The id of the course where the file upload will be done
+     * @param options Upload file configuration
+     * @throws IOException When there is an error communicating with Canvas
+     * @return Deposit (This is part of the file upload workflow)
      */
      Optional<Deposit> uploadFile(String courseId, UploadOptions options) throws IOException;
 }

src/main/java/edu/ksu/canvas/interfaces/FileReader.java

@@ -14,6 +14,7 @@ public interface FileReader extends CanvasReader<File, FileReader> {
      * This is used primarily when you have a redirect after you've uploaded a file.
      * @param url The URL of the file that has been uploaded.
      * @return The file object wrapped in an optional.
+     * @throws IOException When there is an error communicating with Canvas
      */
     Optional<File> getFile(String url) throws IOException;
 }

src/main/java/edu/ksu/canvas/interfaces/SectionWriter.java

@@ -36,7 +36,6 @@ public interface SectionWriter extends CanvasWriter<Section, SectionWriter> {
      * Delete an existing section in Canvas.
      *
      * @param sectionId identifies the section to delete
-     * @return true if the delete was successful
      * @return the section object that was deleted
      * @throws IOException When there is an error communicating with Canvas
      */

src/main/java/edu/ksu/canvas/requestOptions/CreateCommunicationChannelOptions.java

@@ -8,6 +8,7 @@ public class CreateCommunicationChannelOptions extends BaseOptions {
 
     /**
      * Constructs object to hold API options for creating a communication channel.
+     * @param userId The id of the related user
      */
     public CreateCommunicationChannelOptions(String userId) {
         this.userId = userId;

src/main/java/edu/ksu/canvas/requestOptions/CreateContentMigrationOptions.java

@@ -21,6 +21,8 @@ public enum MigrationType {
     /**
      * Constructs object to hold API options for the creating a content migration.
      * A course content migration has its own options class, see CreateCourseContentMigrationOptions.
+     * @param sourceCourseId The id of the source course 
+     * @param migrationType Migration type, see enum options
      */
     public CreateContentMigrationOptions(String sourceCourseId, MigrationType migrationType) {
         this.sourceCourseId = sourceCourseId;