aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Richard Brown <rbrown@exherbo.org> 2007-01-06 14:41:38 +0000
committerAvatar Richard Brown <rbrown@exherbo.org> 2007-01-06 14:41:38 +0000
commitc1920c00a676fe603f7fe4b5646c6f52b8aa03e9 (patch)
tree1fbdc43f05f2b565978a1ad51eb21c820d2d42c7
parenteb705f92d2e8fb45b90029911052687545e124f4 (diff)
downloadpaludis-c1920c00a676fe603f7fe4b5646c6f52b8aa03e9.tar.gz
paludis-c1920c00a676fe603f7fe4b5646c6f52b8aa03e9.tar.xz
Docs work.
-rw-r--r--ruby/dep_atom.cc2
-rw-r--r--ruby/mask_reasons.cc4
-rw-r--r--ruby/paludis_ruby.cc4
-rw-r--r--ruby/qualified_package_name.cc15
-rw-r--r--ruby/version_spec.cc4
5 files changed, 19 insertions, 10 deletions
diff --git a/ruby/dep_atom.cc b/ruby/dep_atom.cc
index 5e83530..0570ee2 100644
--- a/ruby/dep_atom.cc
+++ b/ruby/dep_atom.cc
@@ -242,6 +242,8 @@ namespace
* Document-class: Paludis::CompositeDepAtom
*
* Class for dependency atoms that have a number of child dependency atoms.
+ * Includes Enumerable[http://www.ruby-doc.org/core/classes/Enumerable.html]
+ * but not Comparable.
*/
c_composite_dep_atom = rb_define_class_under(paludis_module(), "CompositeDepAtom", c_dep_atom);
rb_funcall(c_composite_dep_atom, rb_intern("private_class_method"), 1, rb_str_new2("new"));
diff --git a/ruby/mask_reasons.cc b/ruby/mask_reasons.cc
index 6e7af35..73c0d6c 100644
--- a/ruby/mask_reasons.cc
+++ b/ruby/mask_reasons.cc
@@ -92,7 +92,9 @@ namespace
/*
* Document-class: Paludis::MaskReasons
*
- * A collection of reasons for why a package is masked.
+ * A collection of reasons for why a package is masked. Includes
+ * Enumerable[http://www.ruby-doc.org/core/classes/Enumerable.html]
+ * but not Comparable.
*/
c_mask_reasons = rb_define_class_under(paludis_module(), "MaskReasons", rb_cObject);
rb_define_singleton_method(c_mask_reasons, "new", RUBY_FUNC_CAST(&mask_reasons_new), 0);
diff --git a/ruby/paludis_ruby.cc b/ruby/paludis_ruby.cc
index d7a6732..4cc8003 100644
--- a/ruby/paludis_ruby.cc
+++ b/ruby/paludis_ruby.cc
@@ -231,8 +231,8 @@ extern "C"
/*
* Document-module: Paludis
*
- * <b>Paludis</b> is the other package mangler, this is the doc to the ruby binding. The C++ library
- * documentation[http://paludis.berlios.de/doxygen/html/] may also help.
+ * <b>Paludis</b> is the other package mangler, this is the doc to the ruby binding. The C++ library
+ * documentation[http://paludis.org/doxygen/html/] may also help.
*
*/
c_paludis_module = rb_define_module("Paludis");
diff --git a/ruby/qualified_package_name.cc b/ruby/qualified_package_name.cc
index eb7f726..e193de4 100644
--- a/ruby/qualified_package_name.cc
+++ b/ruby/qualified_package_name.cc
@@ -145,7 +145,8 @@ namespace
/*
* Document-class: Paludis::QualifiedPackageName
*
- * Represents a category plus package name.
+ * Represents a category plus package name. Includes
+ * Comparable[http://www.ruby-doc.org/core/classes/Comparable.html]
*/
c_qualified_package_name = rb_define_class_under(paludis_module(), "QualifiedPackageName", rb_cObject);
rb_define_singleton_method(c_qualified_package_name, "new", RUBY_FUNC_CAST(&qualified_package_name_new), -1);
@@ -154,10 +155,14 @@ namespace
rb_include_module(c_qualified_package_name, rb_mComparable);
rb_define_method(c_qualified_package_name, "to_s", RUBY_FUNC_CAST(&Common<QualifiedPackageName>::to_s), 0);
rb_define_alias(c_qualified_package_name, "to_str", "to_s");
- rb_define_method(c_qualified_package_name, "category", RUBY_FUNC_CAST((&QPNMember<CategoryNamePart, &QualifiedPackageName::category>::fetch)), 0);
- rb_define_method(c_qualified_package_name, "category=", RUBY_FUNC_CAST((&QPNMember<CategoryNamePart, &QualifiedPackageName::category>::set)), 1);
- rb_define_method(c_qualified_package_name, "package", RUBY_FUNC_CAST((&QPNMember<PackageNamePart, &QualifiedPackageName::package>::fetch)), 0);
- rb_define_method(c_qualified_package_name, "package=", RUBY_FUNC_CAST((&QPNMember<PackageNamePart, &QualifiedPackageName::package>::set)), 1);
+ rb_define_method(c_qualified_package_name, "category",
+ RUBY_FUNC_CAST((&QPNMember<CategoryNamePart, &QualifiedPackageName::category>::fetch)), 0);
+ rb_define_method(c_qualified_package_name, "category=",
+ RUBY_FUNC_CAST((&QPNMember<CategoryNamePart, &QualifiedPackageName::category>::set)), 1);
+ rb_define_method(c_qualified_package_name, "package",
+ RUBY_FUNC_CAST((&QPNMember<PackageNamePart, &QualifiedPackageName::package>::fetch)), 0);
+ rb_define_method(c_qualified_package_name, "package=",
+ RUBY_FUNC_CAST((&QPNMember<PackageNamePart, &QualifiedPackageName::package>::set)), 1);
}
}
diff --git a/ruby/version_spec.cc b/ruby/version_spec.cc
index cc28edc..ab30c5a 100644
--- a/ruby/version_spec.cc
+++ b/ruby/version_spec.cc
@@ -121,8 +121,8 @@ namespace
/*
* Document-class: Paludis::VersionSpec
*
- * A VersionSpec represents a version number (for example, 1.2.3b-r1).
- *
+ * A VersionSpec represents a version number (for example, 1.2.3b-r1). Includes
+ * Comparable[http://www.ruby-doc.org/core/classes/Comparable.html]
*/
c_version_spec = rb_define_class_under(paludis_module(), "VersionSpec", rb_cObject);
rb_define_singleton_method(c_version_spec, "new", RUBY_FUNC_CAST(&version_spec_new), 1);