nodoc internals

We do not expose any sort of API beyond what's in the config file
manpage to our users.  Do not mislead them into thinking we
currently have a stable API (though I'm considering one).

This avoids wasting disk space and installation time for users who
do not have a: "gem: --no-ri --no-rdoc" line in their ~/.gemrc

1 files changed, 12 insertions, 7 deletions

diff --git a/lib/yahns.rb b/lib/yahns.rb
index 641959c..bbf86f2 100644
--- a/lib/yahns.rb
+++ b/lib/yahns.rb
@@ -14,9 +14,13 @@ require 'sleepy_penguin'
     Unicorn.__send__(:remove_const, sym) if Unicorn.const_defined?(sym)
 end
 
-# yahns exposes no user-visible API outside of the config file
+# yahns exposes no user-visible API outside of the config file.
+# See http://yahns.yhbt.net/yahns_config.txt for the config documentation
+# and http://yahns.yhbt.net/ for the homepage.
 # Internals are subject to change.
-module Yahns # :nodoc:
+
+module Yahns
+  # :stopdoc:
   # We populate this at startup so we can figure out how to reexecute
   # and upgrade the currently running instance of yahns
   # Unlike unicorn, this Hash is NOT a stable/public interface.
@@ -57,15 +61,16 @@ module Yahns # :nodoc:
   # try to use the monotonic clock in Ruby >= 2.1, it is immune to clock
   # offset adjustments and generates less garbage (Float vs Time object)
   begin
-    Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    def self.now
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    def self.now # :nodoc:
+      Process.clock_gettime(Process::CLOCK_MONOTONIC) # :nodoc:
     end
   rescue NameError, NoMethodError
-    def self.now # Ruby <= 2.0
-      Time.now.to_f
+    def self.now # :nodoc:
+      Time.now.to_f # Ruby <= 2.0
     end
   end
+
+  # :startdoc:
 end
 
 # FIXME: require lazily