diff options
| author | takahashim <[email protected]> | 2015-10-11 23:29:06 +0900 |
|---|---|---|
| committer | takahashim <[email protected]> | 2015-10-12 12:45:48 +0900 |
| commit | 4d1b7420a4aaaaa8da14091d95ed007f4efb93ab (patch) | |
| tree | 6fe4bf91ffad6f97cc431f9f7d0ebb811c76b1fa /lib/yard | |
| parent | 815138042c845a74ac17dbd308f43713815c9fd8 (diff) | |
| download | yard-mruby-4d1b7420a4aaaaa8da14091d95ed007f4efb93ab.tar.gz yard-mruby-4d1b7420a4aaaaa8da14091d95ed007f4efb93ab.zip | |
support typedef documentation
cf. #2
* add TypedefObject
* add TypedefHandler for parser
* generate Typedef documents in C header files
Diffstat (limited to 'lib/yard')
| -rw-r--r-- | lib/yard/mruby/code_objects.rb | 1 | ||||
| -rw-r--r-- | lib/yard/mruby/code_objects/header_object.rb | 4 | ||||
| -rw-r--r-- | lib/yard/mruby/code_objects/typedef_object.rb | 8 | ||||
| -rw-r--r-- | lib/yard/mruby/handlers/c/header.rb | 1 | ||||
| -rw-r--r-- | lib/yard/mruby/handlers/c/header/typedef_handler.rb | 31 |
5 files changed, 45 insertions, 0 deletions
diff --git a/lib/yard/mruby/code_objects.rb b/lib/yard/mruby/code_objects.rb index bd41cef..324c1dd 100644 --- a/lib/yard/mruby/code_objects.rb +++ b/lib/yard/mruby/code_objects.rb @@ -3,3 +3,4 @@ require_relative 'code_objects/header_base_object' require_relative 'code_objects/header_object' require_relative 'code_objects/function_object' require_relative 'code_objects/define_object' +require_relative 'code_objects/typedef_object' diff --git a/lib/yard/mruby/code_objects/header_object.rb b/lib/yard/mruby/code_objects/header_object.rb index ddfa5d9..2f9e7e4 100644 --- a/lib/yard/mruby/code_objects/header_object.rb +++ b/lib/yard/mruby/code_objects/header_object.rb @@ -11,6 +11,10 @@ module YARD::MRuby::CodeObjects children.find_all {|d| d.is_a?(DefineObject) } end + def typedefs + children.find_all {|d| d.is_a?(TypedefObject) } + end + def path self.name end diff --git a/lib/yard/mruby/code_objects/typedef_object.rb b/lib/yard/mruby/code_objects/typedef_object.rb new file mode 100644 index 0000000..ce7561b --- /dev/null +++ b/lib/yard/mruby/code_objects/typedef_object.rb @@ -0,0 +1,8 @@ +module YARD::MRuby::CodeObjects + + # A TypedefObject represents a MRuby C API typedef declaration inside a header inside an include directory + class TypedefObject < HeaderBaseObject + end +end + + diff --git a/lib/yard/mruby/handlers/c/header.rb b/lib/yard/mruby/handlers/c/header.rb index 9c955f2..5eff7cb 100644 --- a/lib/yard/mruby/handlers/c/header.rb +++ b/lib/yard/mruby/handlers/c/header.rb @@ -2,3 +2,4 @@ require_relative 'header/base' require_relative 'header/function_handler' require_relative 'header/define_handler' require_relative 'header/header_decl_handler' +require_relative 'header/typedef_handler' diff --git a/lib/yard/mruby/handlers/c/header/typedef_handler.rb b/lib/yard/mruby/handlers/c/header/typedef_handler.rb new file mode 100644 index 0000000..b6166f9 --- /dev/null +++ b/lib/yard/mruby/handlers/c/header/typedef_handler.rb @@ -0,0 +1,31 @@ +module YARD::MRuby::Handlers::C::Header + class TypedefHandler < Base + MATCH = / + typedef + (\s+(\*)?([A-Za-z0-9_\*]+))+ + ; + /mx + + + handles MATCH + statement_class ToplevelStatement + + process do + handle_typedef(statement) + end + + def handle_typedef(statement) + header = self.header(statement.file) + + statement.source.scan(MATCH) do |match| + name = match.last + register TypedefObject.new(header, name) do |obj| + if statement.comments + register_docstring(obj, statement.comments.source, statement) + end + end + end + + end + end +end |
