yard-rustdoc 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9e27bb76802a3dcf98f4c78e30ed98251aed81e4927e464f2da5989768d0328
-  data.tar.gz: 8a96e1280b7bca47976e4d2b74da7a1be05f34428f6d6c1f65528079f2532e49
+  metadata.gz: 58b78b33712ec60e0a4489d201732d967599faf5dfc194cd370de1c2c4a556b2
+  data.tar.gz: bb346446018a4405f9778bac7d6c6d321e73d9b4b397e36d30f889574dfae9c0
 SHA512:
-  metadata.gz: 765bf4cc6f745a9f4d91cbf6eaf17dbf5db45567979bf009d72c684ce6b0e67e6c22ffb2f0f2003b14ce75fef31dd7f4080f36af265d0aa45113d3d141af2689
-  data.tar.gz: 89d3d49913d6ae12be8819472a7536a76b92074cf75828f84571d8125b45049b18ac41fe3cb8553c5e70851b183fdd2de6c083b0626fccfa304bc34f74ba5962
+  metadata.gz: 6ffe5bd2255f7ed7d6fa3e493760b2d7b347bf917398323b2a699b0197d3af123ecbc864161f3d6598ed2b3dc250ce2b3b64508f22782f66fa40f00f5fb44fe4
+  data.tar.gz: d0dd9782942934d8dbffbb195a149ddf346566f61189bb1fc59c40096270d3a5dab5a8ea12efb061c43ca6a57e119be45575758323826e69384b65cfeb59122e

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,7 +10,8 @@ module YARD::Parser::Rustdoc
       end
 
       def docstring
-        @rustdoc.fetch("docs")
+        @docstring ||= rust_docstring
+          .gsub(/^\s*@yard\s*\n/m, "") # remove @yard line
       end
 
       def source
@@ -79,6 +80,18 @@ 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
+
+      def rust_docstring
+        @rustdoc.fetch("docs")
+      end
     end
 
     class Method < Base

data/lib/yard-rustdoc/version.rb

@@ -2,6 +2,6 @@
 
 module YARD
   module Rustdoc
-    VERSION = "0.2.0"
+    VERSION = "0.3.1"
   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.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jimmy Bourassa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-16 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