From e71276ca217c84d9bbc3ebce3d5a79e8190b3527 Mon Sep 17 00:00:00 2001 From: Watson Date: Wed, 24 Oct 2012 22:22:00 +0900 Subject: [PATCH] generate the documents with rdoc ## How to generate the documents $ sudo gem install bundler $ bundle install $ rake rdoc --- .gitignore | 2 ++ Gemfile | 3 +++ Gemfile.lock | 18 ++++++++++++++++++ Rakefile | 19 +++++++++++++++++++ vm | 2 +- 5 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 Gemfile create mode 100644 Gemfile.lock diff --git a/.gitignore b/.gitignore index 9f89a114..56b45990 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,8 @@ doc/.yardoc doc/*.html doc/docset +rdoc/ + lib/motion/version.rb pkg/*.pkg diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..8ea8b0a9 --- /dev/null +++ b/Gemfile @@ -0,0 +1,3 @@ +source :rubygems + +gem "rdoc", :github => "Watson1978/rdoc", :branch => "macruby" \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 00000000..092f2f65 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,18 @@ +GIT + remote: git://github.com/Watson1978/rdoc.git + revision: 872efa77c63aaafe56755c0d2de3f60286cddf12 + branch: macruby + specs: + rdoc (3.12.20121024213649) + json (~> 1.4) + +GEM + remote: http://rubygems.org/ + specs: + json (1.7.5) + +PLATFORMS + ruby + +DEPENDENCIES + rdoc! diff --git a/Rakefile b/Rakefile index 5c9fe6df..c235659a 100644 --- a/Rakefile +++ b/Rakefile @@ -166,3 +166,22 @@ task :upload do AWS::S3::S3Object.store('rubymotion/releases/Latest', PROJECT_VERSION, WEBSITE_BUCKET_NAME) puts "Done!" end + +desc "Generate Documents with rdoc" +task :rdoc do + require 'fileutils' + OUTPUT_DIR = "rdoc" + TARGETS = %w{ + array.c bignum.c class.c compar.c complex.c dir.c encoding.c enum.c + enumerator.c env.c error.c eval.c eval_error.c eval_jump.c eval_safe.c + file.c hash.c io.c kernel.c load.c marshal.c math.c numeric.c object.c + pack.c proc.c process.c random.c range.c rational.c re.c + signal.c sprintf.c string.c struct.c symbol.c thread.c time.c + transcode.c ucnv.c util.c variable.c vm_eval.c vm_method.c + NSArray.m NSDictionary.m NSString.m bridgesupport.cpp gcd.c objc.m + } + files = TARGETS.map{ |x| "vm/#{x}" }.join(" ") + + FileUtils.rm_rf OUTPUT_DIR + sh "bundle exec rdoc #{files} --op #{OUTPUT_DIR}" +end diff --git a/vm b/vm index deb92332..944ef4b0 160000 --- a/vm +++ b/vm @@ -1 +1 @@ -Subproject commit deb92332a9647fa919a83710cdce95ca4b5c8b5a +Subproject commit 944ef4b0099c8101ebf5197d2624898cad7ee1ed