Skip to content

Commit b77899f

Browse files
author
monkstone
committed
references to wiki
1 parent 387685f commit b77899f

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

extensions/basic/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22

33
This project aims to demo small and easy concepts around jruby extensions, this concepts will be listed as
44

5-
* Classes and Modules
6-
* Static methods in both elements
5+
### Creating Classes and Modules
6+
7+
* For java method signatures, and @JRubyMethod annotations see the [wiki][]
78
* Loading the extensions
89
* ...
910

10-
### Polyglot maven build
11+
### Building the extension using polyglot maven
12+
13+
* For details on compiling the java extensions using [polyglot maven][] see this [guide][]
14+
15+
Or for the impatient
1116

1217
```bash
1318
mvn # builds basic.jar
@@ -17,8 +22,6 @@ mvn # builds basic.jar
1722
mvn javadoc:javadoc # javadoc
1823
```
1924

20-
[Polyglot maven][] has to be the way to go (ant was bad enough but maven is bloody diabolical in xml). Polyglot maven is really simple and well thought out (except they don't seem have completely caught up with the _new_ well like since ruby 1.9 hash) but you can use it anyway (and snake case).
21-
22-
23-
24-
[Polyglot maven]:https://github.com/takari/polyglot-maven
25+
[polyglot maven]:https://github.com/takari/polyglot-maven
26+
[wiki]:https://github.com/jruby/jruby/wiki/Method-Signatures-and-Annotations-in-JRuby-extensions
27+
[guide]:https://github.com/jruby/jruby/wiki/Java-extensions-for-JRuby-using-polyglot-maven

extensions/basic/jruby-ext/src/main/java/com/purbon/RubyFoo.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public class RubyFoo {
1818
* Example ruby aliases that return a string. This is a kind of pointless
1919
* method, but is simple to understand. The equivalent in ruby:
2020
* module Foo
21-
* def self.build_string
21+
* def build_string
2222
* return 'This is a new String'
2323
* end alias_method :build_string :new_string
2424
* end

0 commit comments

Comments
 (0)