You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It's currently not possible to generate docs for ruby methods which overload Java classes.
It would be great if YARD would just accept classes defined in JRuby style. Recreating the package structure as modules would be a plus!
Here's some reference:
A warning and the source is shown:
[warn]: in YARD::Handlers::Ruby::Legacy::ClassHandler: Undocumentable class: class org::example::Test
[warn]: in file 'overriding_java.rb':16:
# overriding a java class
class org::example::Test # this is line 16
# a new method for Test
def i_am_new
puts "i am new"
end
# @overload test() from java
def self.test
puts "test in ruby"
end
end
The Java code (which would be documented via javadoc, no worries here):
package org.example;
class Test {
public static void test() {
System.out.println("test in java");
}
}
The text was updated successfully, but these errors were encountered:
Please take a look at #24. I accidently closed it and it's not yet possible to reopen issues in github. Bug #24 is similar to that one but additionally throws an exception.
Since JRuby now supports the Java::Package::Class syntax, I think it would be better to require that syntax. Updating the parser to accept the org.package.Class syntax would be extremely difficult given YARD's design, and 1.9.x users would be unable to take advantage of this functionality (1.9 uses Ripper to parse which directly makes use of Ruby's own parsing rules and therefore cannot be adjusted).
It's currently not possible to generate docs for ruby methods which overload Java classes.
It would be great if YARD would just accept classes defined in JRuby style. Recreating the package structure as modules would be a plus!
Here's some reference:
A warning and the source is shown:
[warn]: in YARD::Handlers::Ruby::Legacy::ClassHandler: Undocumentable class: class org::example::Test
[warn]: in file 'overriding_java.rb':16:
The Java code (which would be documented via javadoc, no worries here):
package org.example;
class Test {
public static void test() {
System.out.println("test in java");
}
}
The text was updated successfully, but these errors were encountered: