yard-rustdoc 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79bdb3aec8e1f714e0171aa730ac8f7ae76a2c03a833469e881c509965b2e570
-  data.tar.gz: 3b9c82a3687ac3dd58f94932e63f1a71ef390314f7a1940dd2b1f2618aec8845
+  metadata.gz: 19da90b28963c2ad60120d5e2922e78420742b86877e25dc3c97ca65f593b4de
+  data.tar.gz: df6a069c8ccd528a89b6107def280d861ad17e6339d515fc67ab0ac7c397173b
 SHA512:
-  metadata.gz: eff3df27844e46ad1ff348af7149e7e87758249f0478afbd88b68692ba84338a9b1a970091b14f703491b6cf78738ebb61b16dc3eae2bc8c49c450ea9f1a2d7d
-  data.tar.gz: be52e56f4bb91b3047b57b8fd1518b9c094e74b0601fdc32349c3e425beac0a6914589997955a9fc37f2a0673c35336cf77dd77b269284578d53092d4f7d26a2
+  metadata.gz: 5452d4c276d7c373621020ae0d9055debdfa9c70c1e2137b1cdff156633a11755d550501e66f8bf16914306c05ac50080991a48f7ae842c7f6367b8456f47716
+  data.tar.gz: ac56ea8762ba940ed2b5e83f1da77013585b80fb9e59e448eaee7ebf043c9d6037f0a74509a1b8d417f3fd2949b6f94a80edc22a19b9e75bffe0fe324adb4638

data/README.md

@@ -1,16 +1,15 @@
 # YARD::Rustdoc
 
 YARD plugin for documenting Magnus-based Rust gems. Supports writing class
-documentation on Struct and method documentation on Struct methods.
-
-**Note**: WIP, not released.
+documentation on Struct and Enums, and method documentation on Struct and Enum
+methods.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'yard-rustdoc'
+gem "yard-rustdoc"
 ```
 
 Load the plugin through `--plugin rustdoc` (e.g. in your project's `.yardopts`).
@@ -73,12 +72,16 @@ impl Bar {
 }
 ```
 
-Defines `Foo::Bar#baz`:
+Defines `Foo::Bar#baz` and `#qux` -- instance method because the method's first
+argument is either `&self` or `rb_self`.
 
 ```rust
 impl Bar {
     /// @yard
     fn baz(&self) {}
+
+    /// @yard
+    fn qux(rb_self: Value) {}
 }
 ```
 
@@ -111,6 +114,7 @@ YARD's syntax differs from what Rustdoc expects. Linters you man want to disable
 ```rust
 #![allow(rustdoc::broken_intra_doc_links)]
 #![allow(rustdoc::invalid_html_tags)]
+#![allow(rustdoc::bare_urls)]
 ```
 
 ## Development

data/lib/yard-rustdoc/parser.rb

@@ -2,6 +2,8 @@
 
 module YARD::Parser::Rustdoc
   class Parser < YARD::Parser::Base
+    TOP_LEVEL_KINDS = ["struct", "enum"].freeze
+
     # This default constructor does nothing. The subclass is responsible for
     # storing the source contents and filename if they are required.
     # @param [String] source the source contents
@@ -28,7 +30,7 @@ module YARD::Parser::Rustdoc
 
       @rustdoc_json.each do |id, entry|
         next unless relevant_entry?(entry)
-        next unless entry["kind"] == "struct"
+        next unless TOP_LEVEL_KINDS.include?(entry["kind"])
 
         methods = entry
           .dig("inner", "impls")

data/lib/yard-rustdoc/statements.rb

@@ -10,7 +10,9 @@ module YARD::Parser::Rustdoc
       end
 
       def docstring
-        @rustdoc.fetch("docs")
+        @docstring ||= @rustdoc
+          .fetch("docs")
+          .gsub(/^\s*@yard\s*\n/m, "") # remove @yard line
       end
 
       def source
@@ -90,7 +92,7 @@ module YARD::Parser::Rustdoc
 
       def scope
         first_arg = @rustdoc.dig("inner", "decl", "inputs", 0, 0)
-        if first_arg == "self"
+        if first_arg == "self" || first_arg == "rb_self"
           :instance
         else
           :class

data/lib/yard-rustdoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-rustdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jimmy Bourassa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.24
 signing_key:
 specification_version: 4
 summary: Generate YARD documentation for Magnus-based Rust gems.