Add nodoc for FFI backend internals

Author: headius

lib/prism/ffi/common.rb

@@ -4,7 +4,7 @@
 
 module Prism
 
-  class Common
+  class Common # :nodoc:
     def dump(string, options) # :nodoc:
       with_buffer do |buffer|
         parse_only(buffer, string, options)
@@ -178,27 +178,27 @@ def dump_options(options)
 
     # Required APIs below
 
-    def with_buffer(&b)
+    def with_buffer(&b) # :nodoc:
       raise NotImplementedError
     end
 
-    def with_string(string, &b)
+    def with_string(string, &b) # :nodoc:
       raise NotImplementedError
     end
 
-    def with_file(string, &b)
+    def with_file(string, &b) # :nodoc:
       raise NotImplementedError
     end
 
-    def lex_only(buffer, string, options)
+    def lex_only(buffer, string, options) # :nodoc:
       raise NotImplementedError
     end
 
-    def parse_only(buffer, string, options)
+    def parse_only(buffer, string, options) # :nodoc:
       raise NotImplementedError
     end
 
-    def parse_stream(buffer, callback, eof_callback, options, source)
+    def parse_stream(buffer, callback, eof_callback, options, source) # :nodoc:
       raise NotImplementedError
     end
 
@@ -214,15 +214,15 @@ def parse_file_success(string, options) # :nodoc:
       raise NotImplementedError
     end
 
-    def string_query_method_name(string)
+    def string_query_method_name(string) # :nodoc:
       raise NotImplementedError
     end
 
-    def string_query_constant(string)
+    def string_query_constant(string) # :nodoc:
       raise NotImplementedError
     end
 
-    def string_query_local(string)
+    def string_query_local(string) # :nodoc:
       raise NotImplementedError
     end
   end

lib/prism/ffi/native_ffi.rb

@@ -250,34 +250,34 @@ def self.with_file(filepath)
   # the prism module.
   private_constant :LibRubyParser
 
-  class NativeCommon < Common
+  class NativeCommon < Common # :nodoc:
 
     # The version constant is set by reading the result of calling pm_version.
     def version
       LibRubyParser.pm_version.read_string.freeze
     end
 
-    def with_buffer(&b)
+    def with_buffer(&b) # :nodoc:
       LibRubyParser::NativeBuffer.with(&b)
     end
 
-    def with_string(string, &b)
+    def with_string(string, &b) # :nodoc:
       LibRubyParser::NativeSource.with_string(string, &b)
     end
 
-    def with_file(string, &b)
+    def with_file(string, &b) # :nodoc:
       LibRubyParser::NativeSource.with_file(string, &b)
     end
 
-    def lex_only(buffer, string, options)
+    def lex_only(buffer, string, options) # :nodoc:
       LibRubyParser.pm_serialize_lex(buffer.pointer, string.pointer, string.length, dump_options(options))
     end
 
-    def parse_only(buffer, string, options)
+    def parse_only(buffer, string, options) # :nodoc:
       LibRubyParser.pm_serialize_parse(buffer.pointer, string.pointer, string.length, dump_options(options))
     end
 
-    def parse_stream(buffer, callback, eof_callback, options, source)
+    def parse_stream(buffer, callback, eof_callback, options, source) # :nodoc:
       pm_source = LibRubyParser.pm_source_stream_new(nil, callback, eof_callback)
       begin
         LibRubyParser.pm_serialize_parse_stream(buffer.pointer, pm_source, dump_options(options))
@@ -305,15 +305,15 @@ def parse_file_success(string, options) # :nodoc:
       LibRubyParser.pm_serialize_parse_success_p(string.pointer, string.length, dump_options(options))
     end
 
-    def string_query_method_name(string)
+    def string_query_method_name(string) # :nodoc:
       LibRubyParser.pm_string_query_method_name(string, string.bytesize, string.encoding.name)
     end
 
-    def string_query_constant(string)
+    def string_query_constant(string) # :nodoc:
       LibRubyParser.pm_string_query_constant(string, string.bytesize, string.encoding.name)
     end
 
-    def string_query_local(string)
+    def string_query_local(string) # :nodoc:
       LibRubyParser.pm_string_query_local(string, string.bytesize, string.encoding.name)
     end
   end

lib/prism/ffi/wasm_ffi.rb

@@ -19,7 +19,7 @@
 require_jar('com.dylibso.chicory', 'log', '1.6.1')
 
 module Prism # :nodoc:
-  class WASMCommon < Common
+  class WASMCommon < Common # :nodoc:
     java_import org.ruby_lang.prism.wasm.Prism
 
     # TODO: concurrency
@@ -30,48 +30,27 @@ def version
       WASM::PRISM.version
     end
 
-    # Prototype WASM code
-    # def dump(source, **options)
-    #   parsed = WASM::PRISM.parse(source.to_java_bytes, dump_options(options).to_java_bytes)
-    # end
-    #
-    # # Mirror the Prism.dump_file API by using the serialization API.
-    # def dump_file(filepath, **options)
-    #   dump_file(File.read(filepath), filepath: filepath, **options)
-    # end
-    #
-    # # Mirror the Prism.lex API by using the serialization API.
-    # def lex(source, **options)
-    #   lexed = WASM::PRISM.lex(source.to_java_bytes, dump_options(options).to_java_bytes)
-    #   Serialize.load_lex(source, lexed, options.fetch(:freeze, false))
-    # end
-    #
-    # # Mirror the Prism.lex_file API by using the serialization API.
-    # def lex_file(filepath, **options)
-    #   lex_file(File.read(filepath), filepath: filepath, **options)
-    # end
-
-    def with_buffer(&b)
+    def with_buffer(&b) # :nodoc:
       raise NotImplementedError
     end
 
-    def with_string(string, &b)
+    def with_string(string, &b) # :nodoc:
       raise NotImplementedError
     end
 
-    def with_file(string, &b)
+    def with_file(string, &b) # :nodoc:
       raise NotImplementedError
     end
 
-    def lex_only(buffer, string, options)
+    def lex_only(buffer, string, options) # :nodoc:
       raise NotImplementedError
     end
 
-    def parse_only(buffer, string, options)
+    def parse_only(buffer, string, options) # :nodoc:
       raise NotImplementedError
     end
 
-    def parse_stream(buffer, callback, eof_callback, options, source)
+    def parse_stream(buffer, callback, eof_callback, options, source) # :nodoc:
       raise NotImplementedError
     end
 
@@ -87,15 +66,15 @@ def parse_file_success(string, options) # :nodoc:
       raise NotImplementedError
     end
 
-    def string_query_method_name(string)
+    def string_query_method_name(string) # :nodoc:
       raise NotImplementedError
     end
 
-    def string_query_constant(string)
+    def string_query_constant(string) # :nodoc:
       raise NotImplementedError
     end
 
-    def string_query_local(string)
+    def string_query_local(string) # :nodoc:
       raise NotImplementedError
     end
   end