From f7d3f3f5b09eaeec384a0e87151198b96339b60c Mon Sep 17 00:00:00 2001
From: Nitish Rathi <NitishRathi@gmail.com>
Date: Fri, 21 Feb 2025 04:35:04 +0000
Subject: [PATCH] documentation to raise coverage to 100%

---
 .yardopts                                  |  2 ++
 lib/mocha.rb                               | 15 +++++++++++++++
 lib/mocha/integration.rb                   |  5 +++++
 lib/mocha/integration/minitest/adapter.rb  |  1 +
 lib/mocha/integration/test_unit/adapter.rb |  1 +
 5 files changed, 24 insertions(+)
 create mode 100644 lib/mocha/integration.rb

diff --git a/.yardopts b/.yardopts
index 5543a4eec..3fa20db0b 100644
--- a/.yardopts
+++ b/.yardopts
@@ -1,5 +1,6 @@
 --output-dir docs
 --no-private
+lib/mocha.rb
 lib/mocha/api.rb
 lib/mocha/hooks.rb
 lib/mocha/mock.rb
@@ -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
 -
diff --git a/lib/mocha.rb b/lib/mocha.rb
index bdc09c000..0cede22ec 100644
--- a/lib/mocha.rb
+++ b/lib/mocha.rb
@@ -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
diff --git a/lib/mocha/integration.rb b/lib/mocha/integration.rb
new file mode 100644
index 000000000..a54d050b1
--- /dev/null
+++ b/lib/mocha/integration.rb
@@ -0,0 +1,5 @@
+module Mocha
+  # Contains adapters that provide built-in support for +Minitest+ and +Test::Unit+.
+  module Integration
+  end
+end
diff --git a/lib/mocha/integration/minitest/adapter.rb b/lib/mocha/integration/minitest/adapter.rb
index 472620308..e1725c443 100644
--- a/lib/mocha/integration/minitest/adapter.rb
+++ b/lib/mocha/integration/minitest/adapter.rb
@@ -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.
       #
diff --git a/lib/mocha/integration/test_unit/adapter.rb b/lib/mocha/integration/test_unit/adapter.rb
index 334f07d16..765c3c9be 100644
--- a/lib/mocha/integration/test_unit/adapter.rb
+++ b/lib/mocha/integration/test_unit/adapter.rb
@@ -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.
       #