Docs: config descriptions, Rake task

Author: olleolleolle

.yardopts

@@ -1,3 +1,4 @@
+-e "./lib/yard-settings/yard-settings.rb"
 --title "Hutch API docs"
 -
 README.md

Rakefile

@@ -11,4 +11,11 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w(--color --format doc)
 end
 
-task :default => :spec
+task default: :spec
+
+#
+# Re-generate API docs
+#
+require 'yard'
+require 'yard/rake/yardoc_task'
+YARD::Rake::YardocTask.new

lib/hutch/config.rb

@@ -40,7 +40,7 @@ def self.boolean_setting(name, _default_value)
     # RabbitMQ hostname
     string_setting :mq_host, '127.0.0.1'
 
-    # RabbitMQ Exchange
+    # RabbitMQ Exchange to use for publishing
     string_setting :mq_exchange, 'hutch'
 
     # RabbitMQ vhost to use
@@ -63,18 +63,28 @@ def self.boolean_setting(name, _default_value)
 
     # [RabbitMQ heartbeat timeout](http://rabbitmq.com/heartbeats.html)
     number_setting :heartbeat, 30
+    # The <tt>basic.qos</tt> prefetch value to use. Default: `0`, no limit. See Bunny and RabbitMQ documentation.
     number_setting :channel_prefetch, 0
+    # Bunny's socket open timeout
     number_setting :connection_timeout, 11
+    # Bunny's socket read timeout
     number_setting :read_timeout, 11
+    # Bunny's socket write timeout
     number_setting :write_timeout, 11
+    # FIXME: DOCUMENT THIS
     number_setting :graceful_exit_timeout, 11
+    # 
     number_setting :consumer_pool_size, 1
 
     boolean_setting :mq_tls, false
+    # Should SSL certificate be verified?
     boolean_setting :mq_verify_peer, true
     boolean_setting :mq_api_ssl, false
     boolean_setting :autoload_rails, true
+    # Should the Hutch runner process daemonise?
     boolean_setting :daemonise, false
+    # Enables publisher confirms. Leaves it up to the app how they are tracked
+    # (e.g. using Hutch::Broker#confirm_select callback or Hutch::Broker#wait_for_confirms)
     boolean_setting :publisher_confirms, false
     boolean_setting :force_publisher_confirms, false
     boolean_setting :enable_http_api_use, true