docscribe 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47833e8613a499efc8e38e215b1a85dfdc4bfe9f853f13c2b51e71bec255e51f
-  data.tar.gz: 9154de314f1ebd9f9ef947cbe5768f398b27495ab5c904673f9da3d3e9a5b9f1
+  metadata.gz: 88fa96ef81689e131461ed06e9f7f4cebff1ac0567416a6417d83418ba2eab3c
+  data.tar.gz: 827dcd841b63dff86681dbd65adcf1cef54089b3dabd121641eb4560052def03
 SHA512:
-  metadata.gz: 7a125e8e5ce3ee31c74fbc52352113f63016358b6d6e8c4a44708b99528f5b37715a202bd24acde17dcf9547321bd2910c3f2e640255ed62bf530a128d08e95e
-  data.tar.gz: 762186336ec1febf4bb03965d1730c353048a2349e4fd18c654ec338cf6b08d058132a9a82708b90216d46458ca8836e6620fd98a7941897c74f9bf93f246d41
+  metadata.gz: 8b4f1c36ae73417133f7f3119df2989b6ea6f6273a188d344887035a9e0c68716896e3d6c179fbf8fd314494940c1f7b8179cbd974a67566922241ed8f7c274f
+  data.tar.gz: 2aa52b164aa86bed76df64af126019f08ad3ef755c044127eca9d022bceed1da1211fc26a772097c4da6d691624a561c850164420026073c1df0e04114a52d99

data/lib/docscribe/config/emit.rb

@@ -122,5 +122,21 @@ module Docscribe
     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

data/lib/docscribe/config/template.rb

@@ -28,7 +28,15 @@ module Docscribe
           # 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

data/lib/docscribe/inline_rewriter/doc_builder.rb

@@ -68,8 +68,10 @@ module Docscribe
           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 @@ module Docscribe
         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

data/lib/docscribe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docscribe
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docscribe
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - unurgunite