Hide internal classes from public docs

Author: eregon

lib/concurrent-ruby/concurrent/re_include.rb

@@ -31,6 +31,8 @@ module Concurrent
   #
   #   C1.new.respond_to? :a # => false
   #   C2.new.respond_to? :a # => true
+  #
+  # @!visibility private
   module ReInclude
     # @!visibility private
     def included(base)

lib/concurrent-ruby/concurrent/synchronization/mutex_lockable_object.rb

@@ -1,7 +1,6 @@
 require 'concurrent/synchronization/abstract_lockable_object'
 
 module Concurrent
-  # noinspection RubyInstanceVariableNamingConvention
   module Synchronization
 
     # @!visibility private

lib/concurrent-ruby/concurrent/synchronization/object.rb

@@ -11,6 +11,7 @@ module Synchronization
     # - final instance variables see {Object.safe_initialization!}
     # - volatile instance variables see {Object.attr_volatile}
     # - volatile instance variables see {Object.attr_atomic}
+    # @!visibility private
     class Object < AbstractObject
       include Volatile
 

lib/concurrent-ruby/concurrent/synchronization/volatile.rb

@@ -23,7 +23,8 @@ module Synchronization
     #  => 1
     #  foo.bar = 2
     #  => 2
-
+    #
+    # @!visibility private
     module Volatile
       def self.included(base)
         base.extend(ClassMethods)

lib/concurrent-ruby/concurrent/tvar.rb

@@ -149,6 +149,7 @@ def leave_transaction
 
   private
 
+  # @!visibility private
   class Transaction
 
     ABORTED = ::Object.new

lib/concurrent-ruby/concurrent/utility/engine.rb

@@ -1,4 +1,5 @@
 module Concurrent
+  # @!visibility private
   module Utility
 
     # @!visibility private

lib/concurrent-ruby/concurrent/utility/native_extension_loader.rb

@@ -3,6 +3,7 @@
 require 'concurrent/synchronization/abstract_object'
 
 module Concurrent
+  # @!visibility private
   module Utility
     # @!visibility private
     module NativeExtensionLoader

lib/concurrent-ruby/concurrent/utility/native_integer.rb

@@ -1,4 +1,5 @@
 module Concurrent
+  # @!visibility private
   module Utility
     # @private
     module NativeInteger

lib/concurrent-ruby/concurrent/utility/processor_counter.rb

@@ -3,6 +3,7 @@
 require 'concurrent/delay'
 
 module Concurrent
+  # @!visibility private
   module Utility
 
     # @!visibility private
@@ -12,43 +13,10 @@ def initialize
         @physical_processor_count = Delay.new { compute_physical_processor_count }
       end
 
-      # Number of processors seen by the OS and used for process scheduling. For
-      # performance reasons the calculated value will be memoized on the first
-      # call.
-      #
-      # When running under JRuby the Java runtime call
-      # `java.lang.Runtime.getRuntime.availableProcessors` will be used. According
-      # to the Java documentation this "value may change during a particular
-      # invocation of the virtual machine... [applications] should therefore
-      # occasionally poll this property." Subsequently the result will NOT be
-      # memoized under JRuby.
-      #
-      # Otherwise Ruby's Etc.nprocessors will be used.
-      #
-      # @return [Integer] number of processors seen by the OS or Java runtime
-      #
-      # @see http://docs.oracle.com/javase/6/docs/api/java/lang/Runtime.html#availableProcessors()
       def processor_count
         @processor_count.value
       end
 
-      # Number of physical processor cores on the current system. For performance
-      # reasons the calculated value will be memoized on the first call.
-      #
-      # On Windows the Win32 API will be queried for the `NumberOfCores from
-      # Win32_Processor`. This will return the total number "of cores for the
-      # current instance of the processor." On Unix-like operating systems either
-      # the `hwprefs` or `sysctl` utility will be called in a subshell and the
-      # returned value will be used. In the rare case where none of these methods
-      # work or an exception is raised the function will simply return 1.
-      #
-      # @return [Integer] number physical processor cores on the current system
-      #
-      # @see https://github.com/grosser/parallel/blob/4fc8b89d08c7091fe0419ca8fba1ec3ce5a8d185/lib/parallel.rb
-      #
-      # @see http://msdn.microsoft.com/en-us/library/aa394373(v=vs.85).aspx
-      # @see http://www.unix.com/man-page/osx/1/HWPREFS/
-      # @see http://linux.die.net/man/8/sysctl
       def physical_processor_count
         @physical_processor_count.value
       end
@@ -99,10 +67,43 @@ def compute_physical_processor_count
   @processor_counter = Utility::ProcessorCounter.new
   singleton_class.send :attr_reader, :processor_counter
 
+  # Number of processors seen by the OS and used for process scheduling. For
+  # performance reasons the calculated value will be memoized on the first
+  # call.
+  #
+  # When running under JRuby the Java runtime call
+  # `java.lang.Runtime.getRuntime.availableProcessors` will be used. According
+  # to the Java documentation this "value may change during a particular
+  # invocation of the virtual machine... [applications] should therefore
+  # occasionally poll this property." Subsequently the result will NOT be
+  # memoized under JRuby.
+  #
+  # Otherwise Ruby's Etc.nprocessors will be used.
+  #
+  # @return [Integer] number of processors seen by the OS or Java runtime
+  #
+  # @see http://docs.oracle.com/javase/6/docs/api/java/lang/Runtime.html#availableProcessors()
   def self.processor_count
     processor_counter.processor_count
   end
 
+  # Number of physical processor cores on the current system. For performance
+  # reasons the calculated value will be memoized on the first call.
+  #
+  # On Windows the Win32 API will be queried for the `NumberOfCores from
+  # Win32_Processor`. This will return the total number "of cores for the
+  # current instance of the processor." On Unix-like operating systems either
+  # the `hwprefs` or `sysctl` utility will be called in a subshell and the
+  # returned value will be used. In the rare case where none of these methods
+  # work or an exception is raised the function will simply return 1.
+  #
+  # @return [Integer] number physical processor cores on the current system
+  #
+  # @see https://github.com/grosser/parallel/blob/4fc8b89d08c7091fe0419ca8fba1ec3ce5a8d185/lib/parallel.rb
+  #
+  # @see http://msdn.microsoft.com/en-us/library/aa394373(v=vs.85).aspx
+  # @see http://www.unix.com/man-page/osx/1/HWPREFS/
+  # @see http://linux.die.net/man/8/sysctl
   def self.physical_processor_count
     processor_counter.physical_processor_count
   end