[1.2.1] Allow disabling default method and param placeholder text (#16)

Author: unurgunite

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-03-27 10:42:03 UTC using RuboCop version 1.84.0.
+# on 2026-03-28 07:58:29 UTC using RuboCop version 1.84.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -16,7 +16,7 @@ Gemspec/DevelopmentDependencies:
 # Offense count: 36
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 97
+  Max: 99
 
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
@@ -37,17 +37,17 @@ Metrics/ClassLength:
 # Offense count: 30
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 41
+  Max: 42
 
 # Offense count: 65
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 105
+  Max: 110
 
 # Offense count: 6
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 396
+  Max: 403
 
 # Offense count: 9
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
@@ -82,21 +82,22 @@ Naming/PredicateMethod:
 RSpec/DescribeClass:
   Enabled: false
 
-# Offense count: 136
+# Offense count: 139
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 33
 
-# Offense count: 122
+# Offense count: 125
 RSpec/MultipleExpectations:
   Max: 7
 
-# Offense count: 13
+# Offense count: 14
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
+    - 'abc.rb'
     - 'lib/docscribe/cli.rb'
     - 'lib/docscribe/cli/config_builder.rb'
     - 'lib/docscribe/cli/init.rb'

lib/docscribe/config/emit.rb

@@ -122,5 +122,21 @@ def param_tag_style
     def param_documentation
       raw.dig('doc', 'param_documentation') || DEFAULT.dig('doc', 'param_documentation')
     end
+
+    # Whether to include the default placeholder line:
+    #   # Method documentation.
+    #
+    # @return [Boolean]
+    def include_default_message?
+      fetch_bool(%w[emit include_default_message], true)
+    end
+
+    # Whether to append placeholder text to generated @param tags:
+    #   # @param [String] name Param documentation.
+    #
+    # @return [Boolean]
+    def include_param_documentation?
+      fetch_bool(%w[emit include_param_documentation], true)
+    end
   end
 end

lib/docscribe/config/template.rb

@@ -28,7 +28,15 @@ def self.default_yaml
           # Emit the header line:
           #
           #   +MyClass#my_method+ -> ReturnType
-          header: true
+          header: false
+
+          # Whether to include the default placeholder line:
+          #   # Method documentation.
+          include_default_message: true
+
+          # Whether to append placeholder text to generated @param tags:
+          #   # @param [String] name Param documentation.
+          include_param_documentation: true
 
           # Emit @param tags.
           param_tags: true

lib/docscribe/inline_rewriter/doc_builder.rb

@@ -68,8 +68,10 @@ def build(insertion, config:, signature_provider: nil)
           lines << "#{indent}#"
         end
 
-        lines << "#{indent}# #{config.default_message(scope, visibility)}"
-        lines << "#{indent}#"
+        if config.include_default_message?
+          lines << "#{indent}# #{config.default_message(scope, visibility)}"
+          lines << "#{indent}#"
+        end
 
         if config.emit_visibility_tags?
           case visibility
@@ -380,7 +382,7 @@ def build_params_lines(node, indent, external_sig:, config:)
         fallback_type = config.fallback_type
         treat_options_keyword_as_hash = config.treat_options_keyword_as_hash?
         param_tag_style = config.param_tag_style
-        param_documentation = config.param_documentation
+        param_documentation = config.include_param_documentation? ? config.param_documentation : ''
 
         args =
           case node.type

spec/docscribe/inline_rewriter/doc_builder_spec.rb

@@ -13,4 +13,65 @@ def foo(x = 1); x; end
     out = inline(code)
     expect(out).to include(param_tag('x', 'Integer'))
   end
+
+  it 'omits the default method message when doc.include_default_message is false' do
+    conf = Docscribe::Config.new(
+      'emit' => { 'include_default_message' => false }
+    )
+
+    code = <<~RUBY
+      class Demo
+        def bump(foo)
+          :ok
+        end
+      end
+    RUBY
+
+    out = inline(code, config: conf)
+
+    expect(out).not_to include('Method documentation.')
+    expect(out).to include('# @param [Object] foo Param documentation.')
+  end
+
+  it 'omits param placeholder text when doc.include_param_documentation is false' do
+    conf = Docscribe::Config.new(
+      'emit' => { 'include_param_documentation' => false }
+    )
+
+    code = <<~RUBY
+      class Demo
+        def bump(foo)
+          :ok
+        end
+      end
+    RUBY
+
+    out = inline(code, config: conf)
+
+    expect(out).to include('# @param [Object] foo')
+    expect(out).not_to include('Param documentation.')
+  end
+
+  it 'omits both method and param placeholder text when both flags are false' do
+    conf = Docscribe::Config.new(
+      'emit' => {
+        'include_default_message' => false,
+        'include_param_documentation' => false
+      }
+    )
+
+    code = <<~RUBY
+      class Demo
+        def bump(foo)
+          :ok
+        end
+      end
+    RUBY
+
+    out = inline(code, config: conf)
+
+    expect(out).not_to include('Method documentation.')
+    expect(out).not_to include('Param documentation.')
+    expect(out).to include('# @param [Object] foo')
+  end
 end