Fill in missing documentation

lexun · May 2, 2015 · 2ee5c89 · 2ee5c89
1 parent 8f166c8
commit 2ee5c89
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/lib/launchpad/gui/application.rb b/lib/launchpad/gui/application.rb
@@ -4,8 +4,7 @@ module Launchpad
   # Main application which is only created once at launch.
   class Application < JRubyFX::Application
     class << self
-      # @!attribute main_stage
-      #   @return [Java::JavafxStage::Stage] the main stage.
+      # @return [Java::JavafxStage::Stage] the main stage.
       attr_accessor :main_stage
     end
 

diff --git a/lib/launchpad/gui/controllers/main_controller.rb b/lib/launchpad/gui/controllers/main_controller.rb
@@ -4,10 +4,10 @@ class MainController
     include JRubyFX::Controller
     fxml 'main.fxml'
 
-    # @return [Launchpad::Patcher]
+    # @return [Launchpad::Patcher] manages syncing local and remote files
     attr_reader :patcher
 
-    # @return [Java::JavafxSceneControl::Label]
+    # @return [Java::JavafxSceneControl::Label] for displaying status to the ui
     attr_reader :status
 
     def initialize

diff --git a/lib/launchpad/patcher.rb b/lib/launchpad/patcher.rb
@@ -1,12 +1,14 @@
 module Launchpad
-  # Updates installation directory with the required files
+  # Updates installation directory with the required files.
   class Patcher
+    # @return [Launchpad::Index] used to determine what needs updating.
     attr_reader :index
 
     def initialize
       @index = Index.new
     end
 
+    # @return [Boolean] determines whether local and remote files are the same.
     def in_sync?
       index.diff.empty?
     end