about summary refs log tree commit homepage
path: root/lib/dtas.rb
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2015-12-14 10:32:25 +0000
committerEric Wong <e@80x24.org>2015-12-15 07:56:05 +0000
commit918f3298510be4505306813bd71699b61ec8dfc5 (patch)
treed8a3797223ae27a98627e1f6ce21fba818c59492 /lib/dtas.rb
parent90dcf561fd22c8a53c03d97292f86a82e74ca4a3 (diff)
downloaddtas-918f3298510be4505306813bd71699b61ec8dfc5.tar.gz
DTAS does not expose any sort of public API for external users,
so it will not be documented using RDoc.  Currently all of our
documentation is in plain-text or Markdown (only for manpages).
Diffstat (limited to 'lib/dtas.rb')
-rw-r--r--lib/dtas.rb16
1 files changed, 11 insertions, 5 deletions
diff --git a/lib/dtas.rb b/lib/dtas.rb
index 0b704ca..468fc3b 100644
--- a/lib/dtas.rb
+++ b/lib/dtas.rb
@@ -1,23 +1,29 @@
 # Copyright (C) 2013-2015 all contributors <dtas-all@nongnu.org>
 # License: GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.txt)
-module DTAS # :nodoc:
+
+# DTAS currently exposes no public API for Ruby programmers.
+# See http://dtas.80x24.org/ for more info.
+module DTAS
+
   # 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)
+  # :stopdoc:
   begin
     ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-    def self.now
+    def self.now # :nodoc:
       ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
     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
 
   @null = nil
-  def self.null
+  def self.null # :nodoc:
     @null ||= File.open('/dev/null', 'r+')
   end
+  # :startdoc:
 end
 
 require_relative 'dtas/compat_onenine'