aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Richard Brown <rbrown@exherbo.org> 2007-01-08 15:17:30 +0000
committerAvatar Richard Brown <rbrown@exherbo.org> 2007-01-08 15:17:30 +0000
commitfe8155b0323c311c5aef69b4a4c17e6d3e5908be (patch)
tree741bdeb7f9ce41ab4397cb78f5df9ca8b2c22a77
parent37343dd18e01eda7cb8641fc911cf44dfff48cf0 (diff)
downloadpaludis-fe8155b0323c311c5aef69b4a4c17e6d3e5908be.tar.gz
paludis-fe8155b0323c311c5aef69b4a4c17e6d3e5908be.tar.xz
Docs work
-rw-r--r--doc/create_ruby_doc.rb9
-rw-r--r--ruby/check.cc8
-rw-r--r--ruby/environment.cc2
-rw-r--r--ruby/metadata_file.cc6
-rw-r--r--ruby/qa_environment.cc4
-rw-r--r--ruby/qualified_package_name.cc7
-rw-r--r--ruby/version_spec.cc6
7 files changed, 26 insertions, 16 deletions
diff --git a/doc/create_ruby_doc.rb b/doc/create_ruby_doc.rb
index 80d0ad6..0231469 100644
--- a/doc/create_ruby_doc.rb
+++ b/doc/create_ruby_doc.rb
@@ -16,12 +16,9 @@ module RDoc
def initialize(top_level, file_name, body, options, stats)
#Paludis and Paludis::QA are already added
body.gsub!('paludis_module()','c_paludis_module')
- # body.gsub!('c_paludis_module','rb_mPaludis')
body.gsub!('paludis_qa_module()','c_paludis_qa_module')
- # body.gsub!('c_paludis_qa_module','rb_mQA')
body.gsub!('no_config_environment_class()','c_no_config_environment')
body.gsub!('environment_class()','c_environment')
-# body.gsub!('paludis_qa_module()','rb_mQA')
#parse_c hates rb_defines over multiple lines
body.gsub!(/(rb_define[^;]+)\n/) {|match| $1}
@@ -56,12 +53,6 @@ module RDoc
super(top_level, file_name, new_body, options, stats)
end
- def scan
- x = super
- puts x.file_relative_name
- x
- end
-
def generate_consts(header, type, in_class)
consts = []
file = IO.readlines("../#{header}").join("").gsub(%r{//.*$},'').gsub(/\s+/,'')
diff --git a/ruby/check.cc b/ruby/check.cc
index dbe199d..5356d72 100644
--- a/ruby/check.cc
+++ b/ruby/check.cc
@@ -59,7 +59,7 @@ namespace
/*
* call-seq:
- * new(qualified_package_name, version_spec, environment_data)
+ * EbuildCheckData.new(qualified_package_name, version_spec, environment_data)
*
* Creates a new EbuildCheckData for EbuildCheck.
*/
@@ -100,9 +100,9 @@ namespace
/*
* call-seq:
- * new(qualified_package_name, version_spec, environment_data, profile)
+ * PerProfileEbuildCheckData.new(qualified_package_name, version_spec, environment_data, profile)
*
- * Creates a new PerProfileEbuildCheckData for PerProfileEbuildCheck.
+ * Creates a new PerProfileEbuildCheckData for PerProfileEbuildCheck.2
*/
VALUE
per_profile_ebuild_check_data_new(int argc, VALUE *argv, VALUE self)
@@ -142,7 +142,7 @@ namespace
/*
* call-seq:
- * new(profiles_dir, profiles_desc_line)
+ * ProfileCheckData.new(profiles_dir, profiles_desc_line)
*
* Creates a new ProfileCheckData for ProfileCheck.
*/
diff --git a/ruby/environment.cc b/ruby/environment.cc
index 0222a2a..23edba0 100644
--- a/ruby/environment.cc
+++ b/ruby/environment.cc
@@ -285,7 +285,7 @@ namespace
/*
* call-seq:
- * new(dir)
+ * NoConfigEnvironment.new(dir) -> NoConfigEnvironment
*
* Create a new NoConfigEnvironment form the specified directory.
*/
diff --git a/ruby/metadata_file.cc b/ruby/metadata_file.cc
index 55ffad8..b98b786 100644
--- a/ruby/metadata_file.cc
+++ b/ruby/metadata_file.cc
@@ -38,6 +38,12 @@ namespace
return self;
}
+ /*
+ * call-seq:
+ * MetadataFile.new(file_name) -> MetadataFile
+ *
+ * Create a new MetadataFile instance from the specified file.
+ */
VALUE
metadata_file_new(int argc, VALUE *argv, VALUE self)
{
diff --git a/ruby/qa_environment.cc b/ruby/qa_environment.cc
index 54311dc..999a397 100644
--- a/ruby/qa_environment.cc
+++ b/ruby/qa_environment.cc
@@ -40,8 +40,8 @@ namespace
/*
* call-seq:
- * new(dir)
- * new(dir, write_cache_dir)
+ * QAEnvironment.new(dir) -> QAEnvironment
+ * QAEnvironment.new(dir, write_cache_dir) -> QAEnvironment
*
* Creates a new QAEnvironment
*/
diff --git a/ruby/qualified_package_name.cc b/ruby/qualified_package_name.cc
index e193de4..cc93f0f 100644
--- a/ruby/qualified_package_name.cc
+++ b/ruby/qualified_package_name.cc
@@ -36,6 +36,13 @@ namespace
return self;
}
+ /*
+ * call-seq:
+ * QualifiedPackageName.new(category_and_package_string) -> QualifiedPackageName
+ * QualifiedPackageName.new(category_name, package_name) -> QualifiedPackageName
+ *
+ * Creates a new QualifiedPackageName.
+ */
VALUE
qualified_package_name_new(int argc, VALUE *argv, VALUE self)
{
diff --git a/ruby/version_spec.cc b/ruby/version_spec.cc
index ab30c5a..142305f 100644
--- a/ruby/version_spec.cc
+++ b/ruby/version_spec.cc
@@ -36,6 +36,12 @@ namespace
return self;
}
+ /*
+ * call-seq:
+ * VersionsSpec.new(version_string) -> VersionSpec
+ *
+ * Creates a new VersionSpec from the given string.
+ */
VALUE
version_spec_new(VALUE self, VALUE s)
{