yard-rustdoc 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19da90b28963c2ad60120d5e2922e78420742b86877e25dc3c97ca65f593b4de
-  data.tar.gz: df6a069c8ccd528a89b6107def280d861ad17e6339d515fc67ab0ac7c397173b
+  metadata.gz: 4967b9c11e8b1ae8ee17256f03033e05312d501c80c0d7b064b406be63b5855d
+  data.tar.gz: 43b2bd77f9fc7c99ec64ae6d499c55fbf9882cbe65a9d550b08cf03ea2c7bf55
 SHA512:
-  metadata.gz: 5452d4c276d7c373621020ae0d9055debdfa9c70c1e2137b1cdff156633a11755d550501e66f8bf16914306c05ac50080991a48f7ae842c7f6367b8456f47716
-  data.tar.gz: ac56ea8762ba940ed2b5e83f1da77013585b80fb9e59e448eaee7ebf043c9d6037f0a74509a1b8d417f3fd2949b6f94a80edc22a19b9e75bffe0fe324adb4638
+  metadata.gz: 0433a034cdf09fe3187b4d206bc857353ee79e56177908157c9c894b5149dc9433f1676ab06dbd7b524fb7a803c4ec5e4072a9f4846e7c995600382f29253fc8
+  data.tar.gz: 258f273a75c1ed52c12a8718641e6ae459acf0d45edba16826d7903d39072e55f4b23bf6fa27fd9f6920a19c9728a1d4f7383c013e7571b45a95d3ff59ac42b6

data/lib/yard-rustdoc/handlers.rb

@@ -34,7 +34,7 @@ module YARD::Handlers
       statement_class(Statements::Struct)
 
       process do
-        obj = YARD::CodeObjects::ClassObject.new(:root, statement.name)
+        obj = statement.code_object_class.new(:root, statement.name)
         register(obj)
 
         push_state(namespace: obj) do

data/lib/yard-rustdoc/statements.rb

@@ -10,8 +10,7 @@ module YARD::Parser::Rustdoc
       end
 
       def docstring
-        @docstring ||= @rustdoc
-          .fetch("docs")
+        @docstring ||= rust_docstring
           .gsub(/^\s*@yard\s*\n/m, "") # remove @yard line
       end
 
@@ -56,6 +55,10 @@ module YARD::Parser::Rustdoc
       def line_index_range
         (@rustdoc.dig("span", "begin", 0) - 1)..@rustdoc.dig("span", "end", 0)
       end
+
+      def rust_docstring
+        @rustdoc.fetch("docs")
+      end
     end
 
     class Struct < Base
@@ -81,6 +84,14 @@ module YARD::Parser::Rustdoc
         # Fallback to the struct's name
         @rustdoc.fetch("name")
       end
+
+      def code_object_class
+        if rust_docstring.match?(/^@module\b/)
+          YARD::CodeObjects::ModuleObject
+        else
+          YARD::CodeObjects::ClassObject
+        end
+      end
     end
 
     class Method < Base

data/lib/yard-rustdoc/version.rb

@@ -2,6 +2,6 @@
 
 module YARD
   module Rustdoc
-    VERSION = "0.3.0"
+    VERSION = "0.3.2"
   end
 end

data/lib/yard-rustdoc.rb

@@ -15,4 +15,5 @@ module YARD
   Tags::Library.define_tag("Tagging docblock for yard", :yard)
   Tags::Library.define_tag("Renaming class & methods", :rename)
   Tags::Library.define_tag("Specify a method name and args", :def)
+  Tags::Library.define_tag("Specify that a Struct should be a module (instead of class)", :module)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-rustdoc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Jimmy Bourassa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement