Skip to content
This repository has been archived by the owner on May 26, 2020. It is now read-only.

Commit

Permalink
Better documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
jdantonio committed May 15, 2015
1 parent 5164dfa commit 3084426
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ The primary site for documentation is the automatically generated [API documenta
* Thread safe, immutable `Either` and `Option` classes based on [Functional Java](http://functionaljava.org/) and [Haskell](https://hackage.haskell.org/package/base-4.2.0.1/docs/Data-Either.html).
* [Memoization](http://en.wikipedia.org/wiki/Memoization) of class methods based on Clojure [memoize](http://clojuredocs.org/clojure_core/clojure.core/memoize).
* Lazy execution with a `Delay` class based on Clojure [delay](http://clojuredocs.org/clojure_core/clojure.core/delay).
* `ValueStruct`, a simple, thread safe, immutable variation of Ruby's [OpenStruct](http://ruby-doc.org/stdlib-2.0/libdoc/ostruct/rdoc/OpenStruct.html) class.
* Thread safe data structures, such as `FinalStruct` and `FinalVar`, which can be written to at most once
before becoming immutable. Based on [Java's `final` keyword](http://en.wikipedia.org/wiki/Final_(Java)).

Expand Down
1 change: 1 addition & 0 deletions lib/functional/abstract_struct.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
module Functional

# An abstract base class for immutable struct classes.
# @!visibility private
module AbstractStruct

# @return [Array] the values of all record fields in order, frozen
Expand Down
1 change: 0 additions & 1 deletion lib/functional/option.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ module Functional
# This type is a replacement for the use of nil with better type checks.
# It is an immutable data structure that extends `AbstractStruct`.
#
# @see Functional::AbstractStruct
# @see http://functionaljava.googlecode.com/svn/artifacts/3.0/javadoc/index.html Functional Java
#
# @!macro thread_safe_immutable_object
Expand Down
1 change: 0 additions & 1 deletion lib/functional/record.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ module Functional
#
# {include:file:doc/record.md}
#
# @see Functional::AbstractStruct
# @see Functional::Union
# @see Functional::Protocol
# @see Functional::TypeCheck
Expand Down
1 change: 0 additions & 1 deletion lib/functional/union.rb
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ module Functional
# Functional::Union::Suit.hearts('Queen')
# #=> #<union Functional::Union::Suit :clubs=>nil, :diamonds=>nil, :hearts=>"Queen", :spades=>nil>
#
# @see Functional::AbstractStruct
# @see Functional::Union
# @see http://www.ruby-doc.org/core-2.1.2/Struct.html Ruby `Struct` class
# @see http://en.wikipedia.org/wiki/Union_type "Union type" on Wikipedia
Expand Down

0 comments on commit 3084426

Please sign in to comment.