diff options
| author | arngo <[email protected]> | 2022-02-02 22:17:11 -0500 |
|---|---|---|
| committer | arngo <[email protected]> | 2022-02-02 22:17:11 -0500 |
| commit | 4e9a5b19c603184c3340fd96d72edf44b3334bbb (patch) | |
| tree | 51689392b886e1af92e91206edc3fd3b486d4605 | |
| parent | 08da136b82adfd4f74973c03da5e4584ac50c03d (diff) | |
| download | mruby-raylib-4e9a5b19c603184c3340fd96d72edf44b3334bbb.tar.gz mruby-raylib-4e9a5b19c603184c3340fd96d72edf44b3334bbb.zip | |
get yarddoc working for mruby c functions
| -rw-r--r-- | .yardoc/checksums | 4 | ||||
| -rw-r--r-- | .yardoc/object_types | bin | 775 -> 2854 bytes | |||
| -rw-r--r-- | .yardoc/objects/root.dat | bin | 11366 -> 47132 bytes | |||
| -rw-r--r-- | .yardopts | 10 | ||||
| -rw-r--r-- | Gemfile | 2 | ||||
| -rw-r--r-- | Rakefile | 21 |
6 files changed, 28 insertions, 9 deletions
diff --git a/.yardoc/checksums b/.yardoc/checksums index 36f29c4..7eafeb7 100644 --- a/.yardoc/checksums +++ b/.yardoc/checksums @@ -1,2 +1,2 @@ -mrblib/raylib.rb ce42382655c9ad1b0aa789cfb6d45d08be4eaf94 -src/raylib.c 36377aaeec5ca596a4d3493599dba11d45dfe2e3 +src/raylib.c a6e9472ccd723550bb796f384ebc2c50f03b1933 +mrblib/raylib.rb 98d89744b3ffefff688c982d791944043c83bd2d diff --git a/.yardoc/object_types b/.yardoc/object_types Binary files differindex 5225e0e..fa5a98a 100644 --- a/.yardoc/object_types +++ b/.yardoc/object_types diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat Binary files differindex 171c994..7da1304 100644 --- a/.yardoc/objects/root.dat +++ b/.yardoc/objects/root.dat diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..408a7e6 --- /dev/null +++ b/.yardopts @@ -0,0 +1,10 @@ +--markup markdown +--plugin mruby +--output-dir ./docs + +src/**/*.c +mrblib/**/*.rb +include/**/*.h + +src/*.c +./mrblib/*.rb @@ -3,5 +3,3 @@ source "https://rubygems.org" # gem "rails" - -gem "yard", "~> 0.9.27" @@ -1,9 +1,20 @@ require 'yard' -task default: [:yard] +task default: [:api] +#task default: [:yard] -YARD::Rake::YardocTask.new do |t| - t.files = ['./mrblib/*', 'src/*'] - t.options = ['--output-dir', './docs', 'yardoc --markup=markdown|textile|rdoc(default)'] - t.stats_options = ['--list-undoc'] +#YARD::Rake::YardocTask.new do |t| +# t.files = ['./mrblib/*', 'src/*'] +# t.options = ['--output-dir', './docs', 'yardoc --markup=markdown|textile|rdoc(default)', '--plugin mruby'] +# t.stats_options = ['--list-undoc'] +#end +# +desc 'generate yard docs' +task :api do + begin + sh "mrbdoc" + rescue + puts "ERROR: To generate yard documentation, you should install yard-mruby gem." + puts " $ gem install yard-mruby yard-coderay" + end end |