Fully qualify constants in documentation

dkubb · Aug 25, 2010 · 8cd0233 · 8cd0233
1 parent 4a4861a
commit 8cd0233
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/lib/yardstick.rb b/lib/yardstick.rb
@@ -15,7 +15,7 @@ module Yardstick
   # @param [Hash] options
   #   optional configuration
   #
-  # @return [MeasurementSet]
+  # @return [Yardstick::MeasurementSet]
   #   the measurements for each file
   #
   # @api public
@@ -35,7 +35,7 @@ def self.measure(path = 'lib/**/*.rb', options = {})
   # @param [Hash] options
   #   optional configuration
   #
-  # @return [MeasurementSet]
+  # @return [Yardstick::MeasurementSet]
   #   the measurements for the string
   #
   # @api public

diff --git a/lib/yardstick/cli.rb b/lib/yardstick/cli.rb
@@ -11,7 +11,7 @@ class CLI
     # @param [Array] *args
     #   arguments passed in from the command line
     #
-    # @return [MeasurementSet]
+    # @return [Yardstick::MeasurementSet]
     #   the measurement for each file
     #
     # @api public
@@ -44,7 +44,7 @@ def self.parse_options(args)
     # @param [Hash] options
     #   the options to set when parsing the command-line arguments
     #
-    # @return [OptionParser]
+    # @return [Yardstick::OptionParser]
     #   the option parser instance
     #
     # @api private

diff --git a/lib/yardstick/measurable.rb b/lib/yardstick/measurable.rb
@@ -6,7 +6,7 @@ module ClassMethods
 
       # List of rules for this class
       #
-      # @return [RuleSet<Rule>]
+      # @return [Yardstick::RuleSet<Rule>]
       #   the rules for this class
       #
       # @api private
@@ -66,7 +66,7 @@ def extended(docstring)
     # @example
     #   docstring.measure  # => [ Measurement ]
     #
-    # @return [MeasurementSet]
+    # @return [Yardstick::MeasurementSet]
     #   a collection of measurements
     #
     # @api public

diff --git a/lib/yardstick/measurement.rb b/lib/yardstick/measurement.rb
@@ -106,7 +106,7 @@ def puts(io = $stdout)
     # @example
     #   measurement == equal_measurement  # => true
     #
-    # @param [Measurement] other
+    # @param [Yardstick::Measurement] other
     #   the other Measurement
     #
     # @return [Boolean]

diff --git a/lib/yardstick/ordered_set.rb b/lib/yardstick/ordered_set.rb
@@ -7,7 +7,7 @@ class OrderedSet
     # @param [Array] entries
     #   optional entries
     #
-    # @return [OrderedSet]
+    # @return [Yardstick::OrderedSet]
     #   the ordered set instance
     #
     # @api private
@@ -22,7 +22,7 @@ def initialize(entries = nil)
     # @param [Object] entry
     #   the object to append
     #
-    # @return [OrderedSet]
+    # @return [Yardstick::OrderedSet]
     #   returns self
     #
     # @api private
@@ -39,7 +39,7 @@ def <<(entry)
     # @param [#each] other
     #   the other ordered set
     #
-    # @return [OrderedSet]
+    # @return [Yardstick::OrderedSet]
     #   returns self
     #
     # @api private
@@ -56,7 +56,7 @@ def merge(other)
     # @yieldparam [Object] entry
     #   an entry in the ordered set
     #
-    # @return [OrderedSet]
+    # @return [Yardstick::OrderedSet]
     #   returns self
     #
     # @api private

diff --git a/lib/yardstick/processor.rb b/lib/yardstick/processor.rb
@@ -6,7 +6,7 @@ class Processor
     # @param [Array<#to_s>, #to_s] path
     #   the files to measure
     #
-    # @return [MeasurementSet]
+    # @return [Yardstick::MeasurementSet]
     #   a collection of measurements
     #
     # @api private
@@ -20,7 +20,7 @@ def self.process_path(path)
     # @param [#to_str] string
     #   the string to measure
     #
-    # @return [MeasurementSet]
+    # @return [Yardstick::MeasurementSet]
     #   a collection of measurements
     #
     # @api private
@@ -31,7 +31,7 @@ def self.process_string(string)
 
     # Measure method objects in YARD registry
     #
-    # @return [MeasurementSet]
+    # @return [Yardstick::MeasurementSet]
     #   a collection of measurements
     #
     # @api private