Add yard generated documentation

Author: rranelli

.gitignore

@@ -4,7 +4,8 @@
 .bundle
 .config
 /.idea
-.yardoc
+.yardoc/*
+yardoc/*
 Gemfile.lock
 InstalledFiles
 _yardoc

.yardopts

@@ -0,0 +1,13 @@
+--protected
+--no-private
+--embed-mixins
+--output-dir ./yardoc
+--markup markdown
+--title=Concurrent Ruby
+--template default
+--template-path ./yard-template
+
+./lib/**/*.rb
+-
+README.md
+LICENSE

Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in thread_safe.gemspec
 gemspec
+
+group :documentation do
+  gem 'countloc', '~> 0.4.0', :platforms => :mri, :require => false
+  gem 'rubycritic', '~> 1.0.2', :platforms => :mri, require: false
+  gem 'yard', '~> 0.8.7.4', :require => false
+  gem 'inch', '~> 0.4.6', :platforms => :mri, :require => false
+  gem 'redcarpet', '~> 3.1.2', platforms: :mri # understands github markdown
+end

yard-template/default/fulldoc/html/css/common.css

@@ -0,0 +1,125 @@
+/* Override this file with custom rules */
+
+body {
+    line-height: 18px;
+}
+
+.docstring code, .docstring .object_link a, #filecontents code {
+    padding: 0px 3px 1px 3px;
+    border: 1px solid #eef;
+    background: #f5f5ff;
+}
+
+#filecontents pre code, .docstring pre code {
+    border: none;
+    background: none;
+    padding: 0;
+}
+
+#filecontents pre.code, .docstring pre.code, .tags pre.example, .docstring code, .docstring .object_link a,
+#filecontents code {
+    -moz-border-radius: 2px;
+    -webkit-border-radius: 2px;
+}
+
+/* syntax highlighting */
+.source_code {
+    display: none;
+    padding: 3px 8px;
+    border-left: 8px solid #ddd;
+    margin-top: 5px;
+}
+
+#filecontents pre.code, .docstring pre.code, .source_code pre {
+    font-family: monospace;
+}
+
+#filecontents pre.code, .docstring pre.code {
+    display: block;
+}
+
+.source_code .lines {
+    padding-right: 12px;
+    color: #555;
+    text-align: right;
+}
+
+#filecontents pre.code, .docstring pre.code,
+.tags pre.example {
+    padding: 5px 12px;
+    margin-top: 4px;
+    border: 1px solid #eef;
+    background: #f5f5ff;
+}
+
+pre.code {
+    color: #000;
+}
+
+pre.code .info.file {
+    color: #555;
+}
+
+pre.code .val {
+    color: #036A07;
+}
+
+pre.code .tstring_content,
+pre.code .heredoc_beg, pre.code .heredoc_end,
+pre.code .qwords_beg, pre.code .qwords_end,
+pre.code .tstring, pre.code .dstring {
+    color: #036A07;
+}
+
+pre.code .fid,
+pre.code .rubyid_new,
+pre.code .rubyid_to_s,
+pre.code .rubyid_to_sym,
+pre.code .rubyid_to_f,
+pre.code .rubyid_to_i,
+pre.code .rubyid_each {
+    color: inherit;
+}
+
+pre.code .comment {
+    color: #777;
+    font-style: italic;
+}
+
+pre.code .const, pre.code .constant {
+    color: inherit;
+    font-weight: bold;
+    font-style: italic;
+}
+
+pre.code .label,
+pre.code .symbol {
+    color: #C5060B;
+}
+
+pre.code .kw,
+pre.code .rubyid_require,
+pre.code .rubyid_extend,
+pre.code .rubyid_include,
+pre.code .int {
+    color: #0000FF;
+}
+
+pre.code .ivar {
+    color: #660E7A;
+}
+
+pre.code .gvar,
+pre.code .rubyid_backref,
+pre.code .rubyid_nth_ref {
+    color: #6D79DE;
+}
+
+pre.code .regexp, .dregexp {
+    color: #036A07;
+}
+
+pre.code a {
+    border-bottom: 1px dotted #bbf;
+}
+

yard-template/default/layout/html/footer.erb

@@ -0,0 +1,16 @@
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
+</div>
+
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-57940973-1', 'auto');
+  ga('send', 'pageview');
+
+</script>