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.