Skip to content

Instantly share code, notes, and snippets.

@clowder
Created April 4, 2011 16:51
Show Gist options
  • Save clowder/901961 to your computer and use it in GitHub Desktop.
Save clowder/901961 to your computer and use it in GitHub Desktop.
commit 0f2b9f95b905cbebb9573e36f9ff0ef78a0b8024
Author: Chris Lowder <clowder@gmail.com>
Date: Mon Apr 4 17:46:17 2011 +0100
A failing example
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..08a8ac9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.yardoc
\ No newline at end of file
diff --git a/.rvmrc b/.rvmrc
new file mode 100644
index 0000000..68f4102
--- /dev/null
+++ b/.rvmrc
@@ -0,0 +1 @@
+rvm use ree-1.8.7@yard_example --create
\ No newline at end of file
diff --git a/.yardopts b/.yardopts
new file mode 100644
index 0000000..e20012e
--- /dev/null
+++ b/.yardopts
@@ -0,0 +1 @@
+yardoc fake.rb
\ No newline at end of file
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..371988d
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,3 @@
+source :gemcutter
+
+gem 'yard'
\ No newline at end of file
diff --git a/Gemfile.lock b/Gemfile.lock
new file mode 100644
index 0000000..e972ff2
--- /dev/null
+++ b/Gemfile.lock
@@ -0,0 +1,10 @@
+GEM
+ remote: http://rubygems.org/
+ specs:
+ yard (0.6.5)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ yard
diff --git a/fake.rb b/fake.rb
new file mode 100644
index 0000000..6c1ad31
--- /dev/null
+++ b/fake.rb
@@ -0,0 +1,11 @@
+class Fake
+ # Returns a BS string
+ #
+ # @param [{Symbol => Object}] opts General options.
+ # @option opts [Boolean] :foo Foo option
+ # @option opts [Integer] :bar Bar option
+ # @return [String]
+ def fake_method(opts={})
+ "BS String"
+ end
+end
\ No newline at end of file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment