Skip to content

Commit

Permalink
Set up documentation using YARD.
Browse files Browse the repository at this point in the history
  • Loading branch information
mdub committed Oct 14, 2009
1 parent d6aa1f9 commit 7e1104d
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 15 deletions.
6 changes: 2 additions & 4 deletions .document
@@ -1,5 +1,3 @@
README.rdoc README.markdown
lib/**/*.rb
bin/*
features/**/*.feature
LICENSE LICENSE
lib/**/*.rb
3 changes: 2 additions & 1 deletion .gitignore
@@ -1,5 +1,6 @@
*.sw? *.sw?
.DS_Store .DS_Store
.yardoc
coverage coverage
rdoc doc
pkg pkg
2 changes: 1 addition & 1 deletion README.markdown
Expand Up @@ -87,7 +87,7 @@ Notice that:


- Representative generates elements for each object-attribute you name (and not the ones you don't). - 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. - 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. with most Ruby XML-to-hash converters.
- Where a named object-attribute is nil, you get an empty element. - Where a named object-attribute is nil, you get an empty element.


Expand Down
16 changes: 8 additions & 8 deletions Rakefile
Expand Up @@ -42,11 +42,11 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
spec.rcov = true spec.rcov = true
end end


# with_gem "yard" do with_gem "yard" do
#
# YARD::Rake::YardocTask.new(:yardoc) do |t| YARD::Rake::YardocTask.new(:yardoc) do |t|
# t.files = FileList['lib/**/*.rb'] t.files = FileList['lib/**/*.rb']
# end end
# CLEAN << "doc" CLEAN << "doc"
#
# end end
6 changes: 5 additions & 1 deletion 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 -*- # -*- encoding: utf-8 -*-


Gem::Specification.new do |s| Gem::Specification.new do |s|
Expand All @@ -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.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Mike Williams"] s.authors = ["Mike Williams"]
s.date = %q{2009-09-06} s.date = %q{2009-10-14}
s.email = %q{mdub@dogbiscuit.org} s.email = %q{mdub@dogbiscuit.org}
s.extra_rdoc_files = [ s.extra_rdoc_files = [
"LICENSE", "LICENSE",
Expand All @@ -23,6 +26,7 @@ Gem::Specification.new do |s|
"init.rb", "init.rb",
"lib/representative.rb", "lib/representative.rb",
"lib/representative/xml.rb", "lib/representative/xml.rb",
"representative.gemspec",
"spec/representative/xml_spec.rb", "spec/representative/xml_spec.rb",
"spec/spec_helper.rb" "spec/spec_helper.rb"
] ]
Expand Down

0 comments on commit 7e1104d

Please sign in to comment.