1
0
Fork 0
mirror of https://github.com/ruby-opencv/ruby-opencv synced 2023-03-27 23:22:12 -04:00

add YARD settings

This commit is contained in:
ser1zw 2012-04-30 19:31:59 +09:00
parent ce0f55d038
commit f6151e75ca
3 changed files with 13 additions and 0 deletions

1
.gitignore vendored
View file

@ -20,3 +20,4 @@ doc/
log.txt
videowriter_result.avi
examples/contours/rotated-boxes-with-detected-bounding-rectangles.jpg
.yardoc

View file

@ -4,6 +4,9 @@ require './ext/opencv/lib/opencv/psyched_yaml'
require 'hoe'
require 'rake/extensiontask'
require './ext/opencv/lib/opencv/version'
require 'yard'
require 'yard/rake/yardoc_task'
require File.dirname(__FILE__) + '/yard_extension'
Hoe.plugin :gemspec
@ -47,4 +50,8 @@ hoespec.spec.signing_key = nil
Rake::Task[:test].prerequisites << :compile
YARD::Rake::YardocTask.new do |t|
t.files = ['ext/opencv/*.cpp', 'ext/opencv/lib/*.rb']
end
# vim: syntax=Ruby

5
yard_extension.rb Normal file
View file

@ -0,0 +1,5 @@
require 'yard'
YARD::Tags::Library.define_tag('Corresponding OpenCV function', :opencv_func)
YARD::Tags::Library.visible_tags.place(:opencv_func).before(:abstract)