Fixing yard docs

Author: durran

.gitignore

@@ -13,7 +13,7 @@
 .yardoc
 coverage
 data
-doc
+docs
 Gemfile.lock
 .ruby-gemset
 .ruby-version

Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 gem 'rake'
+gem 'yard'
 
 platforms :rbx do
   gem 'racc'

Rakefile

@@ -35,3 +35,15 @@ task :release => :spec do
   system "gem push mongo-#{Mongo::VERSION}.gem"
   system "rm mongo-#{Mongo::VERSION}.gem"
 end
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    out = File.join('docs', Mongo::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title mongo-#{Mongo::VERSION}"
+  end
+end

lib/mongo/auth.rb

@@ -56,9 +56,9 @@ module Auth
     # Get the authorization strategy for the provided auth mechanism.
     #
     # @example Get the strategy.
-    #   Auth.get(:mongodb_cr)
+    #   Auth.get(user)
     #
-    # @param [ Symbol ] mechanism The authorization mechanism.
+    # @param [ Auth::User ] user The user object.
     #
     # @return [ CR, X509, LDAP, Kerberos ] The auth strategy.
     #

lib/mongo/cluster/topology/replica_set.rb

@@ -54,7 +54,7 @@ def display_name
         #
         # @param [ Server::Description ] description The description of the
         #   elected primary.
-        # @param [ Array<Server> ] server The list of known servers to the
+        # @param [ Array<Server> ] servers The list of known servers to the
         #   cluster.
         #
         # @return [ ReplicaSet ] The topology.

lib/mongo/cluster/topology/sharded.rb

@@ -45,7 +45,7 @@ def display_name
         #
         # @param [ Server::Description ] description The description of the
         #   elected primary.
-        # @param [ Array<Server> ] server The list of known servers to the
+        # @param [ Array<Server> ] servers The list of known servers to the
         #   cluster.
         #
         # @return [ Sharded ] The topology.

lib/mongo/cluster/topology/standalone.rb

@@ -45,7 +45,7 @@ def display_name
         #
         # @param [ Server::Description ] description The description of the
         #   elected primary.
-        # @param [ Array<Server> ] server The list of known servers to the
+        # @param [ Array<Server> ] servers The list of known servers to the
         #   cluster.
         #
         # @return [ Standalone ] The topology.

lib/mongo/cluster/topology/unknown.rb

@@ -49,7 +49,7 @@ def display_name
         #
         # @param [ Server::Description ] description The description of the
         #   elected primary.
-        # @param [ Array<Server> ] server The list of known servers to the
+        # @param [ Array<Server> ] servers The list of known servers to the
         #   cluster.
         #
         # @return [ Sharded, ReplicaSet ] The new topology.

lib/mongo/collection/view/readable.rb

@@ -271,7 +271,7 @@ def show_disk_loc(value = nil)
         # @example Set the number to skip.
         #   view.skip(10)
         #
-        # @param [ Integer ] skip Number of docs to skip.
+        # @param [ Integer ] number Number of docs to skip.
         #
         # @return [ Integer, View ] Either the skip value or a
         #   new +View+.

lib/mongo/collection/view/writable.rb

@@ -45,7 +45,7 @@ def find_one_and_delete
         # @example Find a document and replace it, returning the new document.
         #   view.find_one_and_replace({ name: 'test' }, :return_document => :after)
         #
-        # @param [ BSON::Document ] document The updates.
+        # @param [ BSON::Document ] replacement The updates.
         # @param [ Hash ] opts The options.
         #
         # @option opts [ Symbol ] :return_document Either :before or :after.

lib/mongo/cursor.rb

@@ -71,8 +71,6 @@ def inspect
     #     ...
     #   end
     #
-    # @yield param [Hash] Each matching document.
-    #
     # @return [ Enumerator ] The enumerator.
     #
     # @since 2.0.0

lib/mongo/error.rb

@@ -40,7 +40,7 @@ class Error < StandardError
 
     # The constant for the writeErrors array.
     #
-    # @sicne 2.0.0
+    # @since 2.0.0
     WRITE_ERRORS = 'writeErrors'.freeze
 
     # The constant for write concern errors.

lib/mongo/error/bulk_write_failure.rb

@@ -29,7 +29,7 @@ class BulkWriteFailure < Error
       # @example Instantiate the exception.
       #   Mongo::Error::BulkWriteFailure.new(response)
       #
-      # @params [ Hash ] result A processed response from the server
+      # @param [ Hash ] result A processed response from the server
       #   reporting results of the operation.
       #
       # @since 2.0.0

lib/mongo/operation/aggregate.rb

@@ -56,7 +56,7 @@ class Aggregate
       # server is not primary, the operation will be rerouted to the primary
       # with a warning.
       #
-      # @params [ Mongo::Server::Context ] The context for this operation.
+      # @param [ Server::Context ] context The context for this operation.
       #
       # @return [ Result ] The operation response, if there is one.
       #

lib/mongo/operation/batchable.rb

@@ -26,7 +26,7 @@ module Batchable
 
       # Slices this operation into the specified number of children operations.
       #
-      # @params [ Integer ] n_batches The number of children operations to split
+      # @param [ Integer ] n_batches The number of children operations to split
       #   this one into.
       #
       # @return [ Array ] An array of children operations.
@@ -64,7 +64,7 @@ def batch(n_batches)
       # Merge another operation with this one.
       # Requires that the collection and database of the two ops are the same.
       #
-      # @params[ Mongo::Operation ] The other operation.
+      # @param[ Mongo::Operation ] The other operation.
       #
       # @return [ self ] This operation merged with the other one.
       #
@@ -81,7 +81,7 @@ def merge!(other)
 
       # Determine if the batch size exceeds a given maximum.
       #
-      # @params[ Integer ] The max batch size.
+      # @param[ Integer ] The max batch size.
       #
       # @return [ true, false ] If this operation exceeds the given batch size.
       #

lib/mongo/operation/command.rb

@@ -41,7 +41,7 @@ class Command
       # @example Execute the operation.
       #   operation.execute(context)
       #
-      # @params [ Mongo::Server::Context ] The context for this operation.
+      # @param [ Server::Context ] context The context for this operation.
       #
       # @return [ Result ] The operation result.
       #

lib/mongo/operation/executable.rb

@@ -25,7 +25,7 @@ module Executable
       # The context gets a connection on which the operation
       # is sent in the block.
       #
-      # @params [ Mongo::Server::Context ] The context for this operation.
+      # @param [ Mongo::Server::Context ] context The context for this operation.
       #
       # @return [ Result ] The operation response, if there is one.
       #
@@ -39,7 +39,7 @@ def execute(context)
       # Merge this operation with another operation, returning a new one.
       # Requires that the collection and database of the two ops are the same.
       #
-      # @params[ Object ] The other operation.
+      # @param[ Object ] The other operation.
       #
       # @return [ Object ] A new operation merging this one and another.
       #
@@ -67,7 +67,7 @@ def namespace
       # If an operation including this module doesn't define #merge!, neither
       # #merge nor #merge! will be allowed.
       #
-      # @params[ Object ] The other operation.
+      # @param[ Object ] The other operation.
       #
       # @raise [ Exception ] Merging is not supported for this operation.
       #

lib/mongo/operation/list_collections/result.rb

@@ -91,8 +91,6 @@ def documents
           # @example Validate the result.
           #   result.validate!
           #
-          # @param [ Hash ] spec The spec used to run the command.
-          #
           # @return [ Result ] Self if successful.
           #
           # @since 2.0.0

lib/mongo/operation/map_reduce.rb

@@ -57,7 +57,7 @@ class MapReduce
       # @example Execute the operation.
       #   operation.execute(context)
       #
-      # @params [ Mongo::Server::Context ] The context for this operation.
+      # @param [ Server::Context ] context The context for this operation.
       #
       # @return [ Result ] The operation response, if there is one.
       #

lib/mongo/operation/read/collections_info.rb

@@ -37,7 +37,7 @@ class CollectionsInfo
         # The context gets a connection on which the operation
         # is sent in the block.
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation response, if there is one.
         #

lib/mongo/operation/read/get_more.rb

@@ -45,7 +45,7 @@ class GetMore
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation response, if there is one.
         #

lib/mongo/operation/read/indexes.rb

@@ -38,7 +38,7 @@ class Indexes
         # The context gets a connection on which the operation
         # is sent in the block.
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The indexes operation response.
         #

lib/mongo/operation/read/list_collections.rb

@@ -43,7 +43,7 @@ class ListCollections
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation result.
         #

lib/mongo/operation/read/list_indexes.rb

@@ -45,7 +45,7 @@ class ListIndexes
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation result.
         #

lib/mongo/operation/read/query.rb

@@ -45,7 +45,7 @@ class Query
         # The context gets a connection on which the operation
         # is sent in the block.
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation response, if there is one.
         #

lib/mongo/operation/write/bulk_delete.rb

@@ -56,7 +56,7 @@ class BulkDelete
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The result.
         #
@@ -74,7 +74,7 @@ def execute(context)
         # @example Set a write concern.
         #   new_op = operation.write_concern(:w => 2)
         #
-        # @params [ Hash ] The write concern.
+        # @param [ Hash ] wc The write concern.
         #
         # @since 2.0.0
         def write_concern(wc = nil)
@@ -87,8 +87,6 @@ def write_concern(wc = nil)
 
         # The index of each delete as it was added onto the bulk object.
         #
-        # @params [ Integer ] The index of each delete.
-        #
         # @since 2.0.0
         def indexes
           @spec[:indexes] || []

lib/mongo/operation/write/bulk_insert.rb

@@ -55,7 +55,7 @@ class BulkInsert
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation result.
         #
@@ -73,7 +73,7 @@ def execute(context)
         # @example Set a write concern.
         #   new_op = operation.write_concern(:w => 2)
         #
-        # @params [ Hash ] The write concern.
+        # @param [ Hash ] wc The write concern.
         #
         # @since 2.0.0
         def write_concern(wc = nil)
@@ -86,8 +86,6 @@ def write_concern(wc = nil)
 
         # The index of each document as it was added onto the bulk object.
         #
-        # @params [ Integer ] The index of each document.
-        #
         # @since 2.0.0
         def indexes
           @spec[:indexes] || []

lib/mongo/operation/write/bulk_update.rb

@@ -63,7 +63,7 @@ class BulkUpdate
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation result.
         #
@@ -81,7 +81,7 @@ def execute(context)
         # @example Set a write concern.
         #   new_op = operation.write_concern(:w => 2)
         #
-        # @params [ Hash ] The write concern.
+        # @param [ Hash ] wc The write concern.
         #
         # @since 2.0.0
         def write_concern(wc = nil)
@@ -94,8 +94,6 @@ def write_concern(wc = nil)
 
         # The index of each update as it was added onto the bulk object.
         #
-        # @params [ Integer ] The index of each update.
-        #
         # @since 2.0.0
         def indexes
           @spec[:indexes] || []

lib/mongo/operation/write/create_index.rb

@@ -49,7 +49,7 @@ class EnsureIndex
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The result of the operation.
         #

lib/mongo/operation/write/create_user.rb

@@ -40,7 +40,7 @@ class CreateUser
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @param [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation result.
         #

lib/mongo/operation/write/delete.rb

@@ -53,7 +53,7 @@ class Delete
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The result.
         #

lib/mongo/operation/write/drop_index.rb

@@ -42,7 +42,7 @@ class DropIndex
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The result of the operation.
         #

lib/mongo/operation/write/insert.rb

@@ -48,7 +48,7 @@ class Insert
         # @example Execute the operation.
         #   operation.execute(context)
         #
-        # @params [ Mongo::Server::Context ] The context for this operation.
+        # @param [ Mongo::Server::Context ] context The context for this operation.
         #
         # @return [ Result ] The operation result.
         #