Skip to content

Commit 84bdeaa

Browse files
author
Blaž Hrastnik
authored
Merge pull request #34 from polyfox/docs
Docs
2 parents 1ff21c6 + 827af18 commit 84bdeaa

76 files changed

Lines changed: 1419 additions & 739 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Gemfile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,7 @@ source 'https://rubygems.org'
33
gem 'guard'
44
gem 'rake'
55
gem 'redcarpet'
6-
gem 'yard'
6+
gem 'yard', '~> 0.9.0'
7+
gem 'yard-mruby', git: 'https://github.com/archSeer/yard-mruby'
8+
9+
gem 'byebug'

Gemfile.lock

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1+
GIT
2+
remote: https://github.com/archSeer/yard-mruby
3+
revision: e1112e6ee2ecae4ffcd8cb9f00ecad03b43a1803
4+
specs:
5+
yard-mruby (0.2.2)
6+
yard
7+
18
GEM
29
remote: https://rubygems.org/
310
specs:
11+
byebug (9.0.5)
412
coderay (1.1.0)
513
ffi (1.9.10)
614
formatador (0.2.5)
@@ -34,16 +42,18 @@ GEM
3442
shellany (0.0.1)
3543
slop (3.6.0)
3644
thor (0.19.1)
37-
yard (0.8.7.6)
45+
yard (0.9.0)
3846

3947
PLATFORMS
4048
ruby
4149

4250
DEPENDENCIES
51+
byebug
4352
guard
4453
rake
4554
redcarpet
46-
yard
55+
yard (~> 0.9.0)
56+
yard-mruby!
4757

4858
BUNDLED WITH
49-
1.11.2
59+
1.12.3

Rakefile

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
11
require 'yard'
2+
require 'yard/mruby'
23
require 'yard/rake/yardoc_task'
34
require_relative 'lib/platform'
45

56
load 'tasks/mruby.rake'
67
load 'tasks/shaders.rake'
78

9+
module YARD::MRuby::Handlers::C::Source
10+
class InitHandler < Base
11+
MATCH3 = /mmrb_\w+_init\s*\(/mx
12+
handles MATCH3
13+
end
14+
end
15+
16+
YARD::Parser::SourceParser.register_parser_type :header, YARD::MRuby::Parser::C::HeaderParser, 'hxx'
17+
YARD::Parser::SourceParser.register_parser_type :source, YARD::MRuby::Parser::C::SourceParser, 'cxx'
18+
819
YARD::Rake::YardocTask.new do |t|
9-
t.files = ['docstub/**/*.rb',
10-
'modules/**/*.rb']
20+
t.files = %w{modules/system/mrblib/typed_attributes.rb
21+
modules/**/src/**/mrb_*.cxx modules/**/mrblib/**/*.rb modules/**/include/**/mrb/**/*.hxx}
1122
end
1223

1324
task :cmake_clean do

docstub/audio/audio.rb

Lines changed: 0 additions & 8 deletions
This file was deleted.

docstub/audio/music.rb

Lines changed: 0 additions & 48 deletions
This file was deleted.

docstub/audio/sound.rb

Lines changed: 0 additions & 17 deletions
This file was deleted.

docstub/graphics/font.rb

Lines changed: 0 additions & 10 deletions
This file was deleted.

docstub/graphics/shader.rb

Lines changed: 0 additions & 12 deletions
This file was deleted.

docstub/graphics/sprite.rb

Lines changed: 0 additions & 31 deletions
This file was deleted.

docstub/graphics/spritesheet.rb

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)