write docs about class

ma2gedev · Jan 29, 2015 · e1e0abd · e1e0abd
1 parent 97d753b
commit e1e0abd
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,7 @@
 [![Build Status](https://travis-ci.org/ma2gedev/chrono_logger.svg)](https://travis-ci.org/ma2gedev/chrono_logger)
 [![Code Climate](https://codeclimate.com/github/ma2gedev/chrono_logger/badges/gpa.svg)](https://codeclimate.com/github/ma2gedev/chrono_logger)
 [![Coverage Status](https://coveralls.io/repos/ma2gedev/chrono_logger/badge.svg)](https://coveralls.io/r/ma2gedev/chrono_logger)
+[![Inline docs](http://inch-ci.org/github/ma2gedev/chrono_logger.svg?branch=master)](http://inch-ci.org/github/ma2gedev/chrono_logger)
 [![endorse](https://api.coderwall.com/ma2gedev/endorsecount.png)](https://coderwall.com/ma2gedev)
 
 A lock-free logger with timebased file rotation.

diff --git a/lib/chrono_logger.rb b/lib/chrono_logger.rb
@@ -1,7 +1,16 @@
 require "chrono_logger/version"
 require 'logger'
 
+# A lock-free logger with timebased file rotation.
 class ChronoLogger < Logger
+
+  # @param logdev [String, IO] `Time#strftime` formatted filename (String) or IO object (typically STDOUT, STDERR, or an open file).
+  # @example
+  #
+  #   ChronoLogger.new('/log/production.log.%Y%m%d')
+  #   Time.now.strftime('%F')                       => "2015-01-29"
+  #   File.exist?('/log/production.log.20150129')   => true
+  #
   def initialize(logdev)
     @progname = nil
     @level = DEBUG