Browse files

Add missing class descriptions

  • Loading branch information...
1 parent 6153ddc commit 065568692c1a9e3f9f6b0108b52200a6bbb33562 @dkubb committed Oct 28, 2012
View
2 lib/yardstick/cli.rb
@@ -1,6 +1,8 @@
require 'optparse'
module Yardstick
+
+ # Handle the yardstick command line interface
class CLI
# Parse the command line options, and run the command
View
2 lib/yardstick/measurement.rb
@@ -1,4 +1,6 @@
module Yardstick
+
+ # A measurement given a constraint on the docs
class Measurement
# Return the Measurement description
View
2 lib/yardstick/measurement_set.rb
@@ -1,4 +1,6 @@
module Yardstick
+
+ # A set of yardstick measurements
class MeasurementSet < OrderedSet
# The total number of measurements
View
2 lib/yardstick/ordered_set.rb
@@ -1,4 +1,6 @@
module Yardstick
+
+ # A base class for an ordered set
class OrderedSet
include Enumerable
View
2 lib/yardstick/processor.rb
@@ -1,4 +1,6 @@
module Yardstick
+
+ # Handle procesing a docstring or path of files
class Processor
# Measure files provided
View
2 lib/yardstick/rake/measurement.rb
@@ -6,6 +6,8 @@
module Yardstick
module Rake
+
+ # A rake task for measuring docs in a set of files
class Measurement < ::Rake::TaskLib
# List of paths to measure
View
2 lib/yardstick/rake/verify.rb
@@ -5,6 +5,8 @@
module Yardstick
module Rake
+
+ # A rake task for verifying the doc thresholds
class Verify < ::Rake::TaskLib
# Set the threshold
View
2 lib/yardstick/rule.rb
@@ -1,4 +1,6 @@
module Yardstick
+
+ # A constraint on the docs
class Rule
# Return a Rule instance
View
2 lib/yardstick/rule_set.rb
@@ -1,4 +1,6 @@
module Yardstick
+
+ # A set of rules to apply to docs
class RuleSet < OrderedSet
# Measure a docstring with all Rules
View
2 lib/yardstick/yard_ext.rb
@@ -1,5 +1,7 @@
module YARD #:nodoc: all
module CodeObjects
+
+ # A YARD extension
class MethodObject
# Return the docstring associated with the method

0 comments on commit 0655686

Please sign in to comment.