Updated Yardoc for CAtomicBoolean and CAtomicFixnum.

Author: jdantonio

.yardopts

@@ -8,6 +8,7 @@
 --template-path ./yard-template
 
 ./lib/**/*.rb
+./ext/concurrent_ruby_ext/**/*.c
 -
 README.md
 LICENSE.txt

lib/concurrent/atomic/atomic_boolean.rb

@@ -6,21 +6,20 @@ module Concurrent
   #   boolean and thread-safe and guaranteed to succeed. Reads and writes may block
   #   briefly but no explicit locking is required.
   #
-  #   @since 0.6.0
   #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicBoolean.html java.util.concurrent.atomic.AtomicBoolean
   class MutexAtomicBoolean
 
     # @!macro [attach] atomic_boolean_method_initialize
     #
-    # Creates a new `AtomicBoolean` with the given initial value.
+    #   Creates a new `AtomicBoolean` with the given initial value.
     #
-    # @param [Boolean] initial the initial value
+    #   @param [Boolean] initial the initial value
     def initialize(initial = false)
       @value = !!initial
       @mutex = Mutex.new
     end
 
-    # @!macro [attach] atomic_boolean_method_value
+    # @!macro [attach] atomic_boolean_method_value_get
     #
     #   Retrieves the current `Boolean` value.
     #
@@ -32,7 +31,7 @@ def value
       @mutex.unlock
     end
 
-    # @!macro [attach] atomic_boolean_method_value_eq
+    # @!macro [attach] atomic_boolean_method_value_set
     #
     #   Explicitly sets the value.
     #
@@ -47,9 +46,9 @@ def value=(value)
       @mutex.unlock
     end
 
-    # @!macro [attach] atomic_boolean_method_is_true
+    # @!macro [attach] atomic_boolean_method_true_question
     #
-    #   Is the current value `true`?
+    #   Is the current value `true`
     #
     #   @return [Boolean] true if the current value is `true`, else false
     def true?
@@ -59,9 +58,9 @@ def true?
       @mutex.unlock
     end
 
-    # @!macro [attach] atomic_boolean_method_is_false
+    # @!macro atomic_boolean_method_false_question
     #
-    #   Is the current value `true`?false
+    #   Is the current value `false`
     #
     #   @return [Boolean] true if the current value is `false`, else false
     def false?
@@ -111,24 +110,24 @@ def initialize(initial = false)
         @atomic = java.util.concurrent.atomic.AtomicBoolean.new(!!initial)
       end
 
-      # @!macro atomic_boolean_method_value
+      # @!macro atomic_boolean_method_value_get
       #
       def value
         @atomic.get
       end
 
-      # @!macro atomic_boolean_method_value_eq
+      # @!macro atomic_boolean_method_value_set
       #
       def value=(value)
         @atomic.set(!!value)
       end
 
-      # @!macro [attach] atomic_boolean_method_is_true
+      # @!macro atomic_boolean_method_true_question
       def true?
         @atomic.get
       end
 
-      # @!macro [attach] atomic_boolean_method_is_false
+      # @!macro atomic_boolean_method_false_question
       def false?
         !@atomic.get
       end
@@ -144,13 +143,37 @@ def make_false
       end
     end
 
-
     # @!macro atomic_boolean
     class AtomicBoolean < JavaAtomicBoolean
     end
 
   elsif defined? Concurrent::CAtomicBoolean
 
+    # @!macro atomic_boolean
+    class CAtomicBoolean
+
+      # @!method initialize
+      #   @!macro atomic_boolean_method_initialize
+
+      # @!method value
+      #   @!macro atomic_boolean_method_value_get
+
+      # @!method value=
+      #   @!macro atomic_boolean_method_value_set
+
+      # @!method true?
+      #   @!macro atomic_boolean_method_true_question
+
+      # @!method false?
+      #   @!macro atomic_boolean_method_false_question
+
+      # @!method make_true
+      #   @!macro atomic_boolean_method_make_true
+
+      # @!method make_false
+      #   @!macro atomic_boolean_method_make_false
+    end
+
     # @!macro atomic_boolean
     class AtomicBoolean < CAtomicBoolean
     end

lib/concurrent/atomic/atomic_fixnum.rb

@@ -6,7 +6,6 @@ module Concurrent
   #   fixnum and thread-safe and guaranteed to succeed. Reads and writes may block
   #   briefly but no explicit locking is required.
   #
-  #   @since 0.5.0
   #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicLong.html java.util.concurrent.atomic.AtomicLong
   class MutexAtomicFixnum
 
@@ -16,17 +15,17 @@ class MutexAtomicFixnum
 
     # @!macro [attach] atomic_fixnum_method_initialize
     #
-    # Creates a new `AtomicFixnum` with the given initial value.
+    #   Creates a new `AtomicFixnum` with the given initial value.
     #
-    # @param [Fixnum] init the initial value
-    # @raise [ArgumentError] if the initial value is not a `Fixnum`
+    #   @param [Fixnum] init the initial value
+    #   @raise [ArgumentError] if the initial value is not a `Fixnum`
     def initialize(init = 0)
       raise ArgumentError.new('initial value must be a Fixnum') unless init.is_a?(Fixnum)
       @value = init
       @mutex = Mutex.new
     end
 
-    # @!macro [attach] atomic_fixnum_method_value
+    # @!macro [attach] atomic_fixnum_method_value_get
     #
     #   Retrieves the current `Fixnum` value.
     #
@@ -38,7 +37,7 @@ def value
       @mutex.unlock
     end
 
-    # @!macro [attach] atomic_fixnum_method_value_eq
+    # @!macro [attach] atomic_fixnum_method_value_set
     #
     #   Explicitly sets the value.
     #
@@ -114,43 +113,35 @@ class JavaAtomicFixnum
       MAX_VALUE = Java::JavaLang::Long::MAX_VALUE
 
       # @!macro atomic_fixnum_method_initialize
-      #
       def initialize(init = 0)
         raise ArgumentError.new('initial value must be a Fixnum') unless init.is_a?(Fixnum)
         @atomic = java.util.concurrent.atomic.AtomicLong.new(init)
       end
 
-      # @!macro atomic_fixnum_method_value
-      #
+      # @!macro atomic_fixnum_method_value_get
       def value
         @atomic.get
       end
 
-      # @!macro atomic_fixnum_method_value_eq
-      #
+      # @!macro atomic_fixnum_method_value_set
       def value=(value)
         raise ArgumentError.new('value must be a Fixnum') unless value.is_a?(Fixnum)
         @atomic.set(value)
       end
 
       # @!macro atomic_fixnum_method_increment
-      #
       def increment
         @atomic.increment_and_get
       end
-
       alias_method :up, :increment
 
       # @!macro atomic_fixnum_method_decrement
-      #
       def decrement
         @atomic.decrement_and_get
       end
-
       alias_method :down, :decrement
 
       # @!macro atomic_fixnum_method_compare_and_set
-      #
       def compare_and_set(expect, update)
         @atomic.compare_and_set(expect, update)
       end
@@ -160,6 +151,30 @@ def compare_and_set(expect, update)
     class AtomicFixnum < JavaAtomicFixnum
     end
 
+  elsif defined? Concurrent::CAtomicFixnum
+
+    # @!macro atomic_fixnum
+    class CAtomicFixnum
+
+      # @!method initialize
+      #   @!macro atomic_fixnum_method_initialize
+
+      # @!method value
+      #   @!macro atomic_fixnum_method_value_get
+
+      # @!method value=
+      #   @!macro atomic_fixnum_method_value_set
+
+      # @!method increment
+      #   @!macro atomic_fixnum_method_increment
+
+      # @!method decrement
+      #   @!macro atomic_fixnum_method_decrement
+
+      # @!method compare_and_set
+      #   @!macro atomic_fixnum_method_compare_and_set
+    end
+
   else
 
     # @!macro atomic_fixnum