Skip to content

Commit

Permalink
documentation to raise coverage to 100%
Browse files Browse the repository at this point in the history
  • Loading branch information
nitishr authored and floehopper committed Feb 24, 2025
1 parent 9f08b75 commit f7d3f3f
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
--output-dir docs
--no-private
lib/mocha.rb
lib/mocha/api.rb
lib/mocha/hooks.rb
lib/mocha/mock.rb
Expand All @@ -15,6 +16,7 @@ lib/mocha/expectation_error_factory.rb
lib/mocha/expectation_error.rb
lib/mocha/stubbing_error.rb
lib/mocha/unexpected_invocation.rb
lib/mocha/integration.rb
lib/mocha/integration/test_unit/adapter.rb
lib/mocha/integration/minitest/adapter.rb
-
Expand Down
15 changes: 15 additions & 0 deletions lib/mocha.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,20 @@

require 'mocha/version'

# Mocha's top level namespace, which also provides the ability to {.configure configure} Mocha's behavior.
#
# Methods in the {API} are directly available in +Test::Unit::TestCase+, +Minitest::Unit::TestCase+.
#
# The mock creation methods are {API#mock mock}, {API#stub stub} and {API#stub_everything stub_everything}, all of which return a {Mock}
#
# A {Mock} {Mock#expects expects} or {Mock#stubs stubs} a method, which sets up (returns) an {Expectation}.
#
# An {Expectation} can be further qualified through its {Expectation fluent interface}.
#
# {ParameterMatchers} for {Expectation#with} restrict the parameter values which will match the {Expectation}.
#
# Adapters in {Integration} provide built-in support for +Minitest+ and +Test::Unit+.
#
# Integration {Hooks} enable support for other test frameworks.
module Mocha
end
5 changes: 5 additions & 0 deletions lib/mocha/integration.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module Mocha
# Contains adapters that provide built-in support for +Minitest+ and +Test::Unit+.
module Integration
end
end
1 change: 1 addition & 0 deletions lib/mocha/integration/minitest/adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

module Mocha
module Integration
# Contains {Adapter} that integrates Mocha into recent versions of Minitest.
module Minitest
# Integrates Mocha into recent versions of Minitest.
#
Expand Down
1 change: 1 addition & 0 deletions lib/mocha/integration/test_unit/adapter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

module Mocha
module Integration
# Contains {Adapter} that integrates Mocha into recent versions of Test::Unit.
module TestUnit
# Integrates Mocha into recent versions of Test::Unit.
#
Expand Down

0 comments on commit f7d3f3f

Please sign in to comment.