Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Set up documentation using YARD.

  • Loading branch information...
commit 7e1104d3bf45f6b48a24f5ffd9feeb25fc3d7335 1 parent d6aa1f9
@mdub authored
View
6 .document
@@ -1,5 +1,3 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
+README.markdown
LICENSE
+lib/**/*.rb
View
3  .gitignore
@@ -1,5 +1,6 @@
*.sw?
.DS_Store
+.yardoc
coverage
-rdoc
+doc
pkg
View
2  README.markdown
@@ -87,7 +87,7 @@ Notice that:
- Representative generates elements for each object-attribute you name (and not the ones you don't).
- The structure of the XML mirrors the structure described by the nested Ruby blocks.
-- Using **list_of!** for a collection attribute generates an "array" element, which plays nicely
+- Using `list_of!` for a collection attribute generates an "array" element, which plays nicely
with most Ruby XML-to-hash converters.
- Where a named object-attribute is nil, you get an empty element.
View
16 Rakefile
@@ -42,11 +42,11 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
spec.rcov = true
end
-# with_gem "yard" do
-#
-# YARD::Rake::YardocTask.new(:yardoc) do |t|
-# t.files = FileList['lib/**/*.rb']
-# end
-# CLEAN << "doc"
-#
-# end
+with_gem "yard" do
+
+ YARD::Rake::YardocTask.new(:yardoc) do |t|
+ t.files = FileList['lib/**/*.rb']
+ end
+ CLEAN << "doc"
+
+end
View
6 representative.gemspec
@@ -1,3 +1,6 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
# -*- encoding: utf-8 -*-
Gem::Specification.new do |s|
@@ -6,7 +9,7 @@ Gem::Specification.new do |s|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Mike Williams"]
- s.date = %q{2009-09-06}
+ s.date = %q{2009-10-14}
s.email = %q{mdub@dogbiscuit.org}
s.extra_rdoc_files = [
"LICENSE",
@@ -23,6 +26,7 @@ Gem::Specification.new do |s|
"init.rb",
"lib/representative.rb",
"lib/representative/xml.rb",
+ "representative.gemspec",
"spec/representative/xml_spec.rb",
"spec/spec_helper.rb"
]
Please sign in to comment.
Something went wrong with that request. Please try again.