Skip to content

Commit

Permalink
Removed @Private & :nodoc: tags from documentation, but added --no-pr…
Browse files Browse the repository at this point in the history
…ivate to .yardopts for future convenience.
  • Loading branch information
ginjo committed Jan 14, 2012
1 parent 60be794 commit 68ecbb3
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 15 deletions.
1 change: 1 addition & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
--no-private
-
CHANGELOG.md
LICENSE
Expand Down
15 changes: 8 additions & 7 deletions lib/rfm/utilities/compound_query.rb
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# The classes in this module are used internally by RFM and are not intended for outside use.
module Rfm


# Class to build complex FMP queries
# Perform Filemaker find using complex boolean logic (multiple value options for a single field)
# Or create multiple find requests.
# Also allow find requests to be :omit
class CompoundQuery < Array # @private :nodoc:
# Class to build complex FMP queries.
# Perform Filemaker find using complex boolean logic (multiple value options for a single field),
# or create multiple find requests.
# Also allow find requests to be :omit.
class CompoundQuery < Array

attr_accessor :original_input, :query_type, :key_values, :key_arrays, :key_map, :key_map_string, :key_counter

Expand Down Expand Up @@ -65,7 +66,7 @@ def build_query(input=original_input)
end


# Build key-value definitions and query map '-q1...'
# Build key-value definitions and query map '-q1...'.
# Converts query_hash to fmresultset uri format for -findquery query type.
def build_key_values(input_hash)
input_hash = input_hash.clone
Expand All @@ -89,7 +90,7 @@ def build_key_values(input_hash)


# Input array of arrays.
# Transform single key_array into key_map (array of requests)
# Transform single key_array into key_map (array of requests).
# Creates all combinations of sub-arrays where each combination contains one element of each subarray.
def build_key_map(key_array)
key_array = key_array.clone
Expand Down
2 changes: 1 addition & 1 deletion lib/rfm/utilities/core_ext.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
include Forwardable
end

class Object # @private :nodoc: all
class Object

#extend Forwardable

Expand Down
2 changes: 1 addition & 1 deletion lib/rfm/utilities/factory.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ module Factory
extend Config
config :parent=>'Rfm::Config'

class ServerFactory < Rfm::CaseInsensitiveHash # @private :nodoc: all
class ServerFactory < Rfm::CaseInsensitiveHash

def [](host, conf = Factory.get_config) #(Factory.instance_variable_get(:@config) || {}))
conf[:host] = host
Expand Down
6 changes: 3 additions & 3 deletions lib/rfm/utilities/xml_parser.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module Rfm
module XmlParser # @private :nodoc: all
module XmlParser

extend Config
config :parent=>'Rfm::Config'
Expand All @@ -12,7 +12,7 @@ module XmlParser # @private :nodoc: all
BACKENDS[:jdom] = {:require=>'jdom', :class => 'JDOM'}

BACKENDS[:oxsax] = {:require=>'ox', :class => proc{
# rexmlsax module is part of Rfm, not XmlMini,
# Ox module is part of Rfm, not XmlMini,
# and needs to be handed manually to XmlMini.
require File.join(File.dirname(__FILE__), '../xml_mini/ox_sax.rb')
ActiveSupport::XmlMini_OxSAX}}
Expand All @@ -34,7 +34,7 @@ module XmlParser # @private :nodoc: all
BACKENDS[:rexml] = {:require=>'rexml/document', :class=>'REXML'}

BACKENDS[:rexmlsax] = {:require=>'rexml/parsers/sax2parser', :class => proc{
# rexmlsax module is part of Rfm, not XmlMini,
# Rexmlsax module is part of Rfm, not XmlMini,
# and needs to be handed manually to XmlMini.
require File.join(File.dirname(__FILE__), '../xml_mini/rexml_sax.rb')
ActiveSupport::XmlMini_REXMLSAX}}
Expand Down
4 changes: 2 additions & 2 deletions lib/rfm/xml_mini/hpricot.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
require 'active_support/core_ext/object/blank'
require 'stringio'

module ActiveSupport # @private :nodoc:
module XmlMini_Hpricot # @private :nodoc:
module ActiveSupport
module XmlMini_Hpricot
extend self

CONTENT_KEY = '__content__'.freeze
Expand Down
2 changes: 1 addition & 1 deletion lib/rfm/xml_mini/ox_sax.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# = XmlMini Ox implementation using a SAX-based parser
# This Ox Sax parser was lifted directly from multi_xml gem.
module ActiveSupport
module XmlMini_OxSAX # @private :nodoc: all
module XmlMini_OxSAX

extend self

Expand Down

0 comments on commit 68ecbb3

Please sign in to comment.