Skip to content

Commit 4505f04

Browse files
committed
chore: Update tags and locations for private implementations
1 parent 8aedef7 commit 4505f04

File tree

17 files changed

+49
-49
lines changed

17 files changed

+49
-49
lines changed

lib/ldclient-rb/cache_store.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ module LaunchDarkly
55
# A thread-safe in-memory store that uses the same semantics that Faraday would expect, although we
66
# no longer use Faraday. This is used by Requestor, when we are not in a Rails environment.
77
#
8-
# @private
8+
# @api private
99
#
1010
class ThreadSafeMemoryStore
1111
#

lib/ldclient-rb/config.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def initialize(opts = {})
9696
# Custom data source implementations should integrate with this sink if
9797
# they want to provide support for data source status listeners.
9898
#
99-
# @private
99+
# @api private
100100
#
101101
attr_accessor :data_source_update_sink
102102

@@ -108,7 +108,7 @@ def initialize(opts = {})
108108
# property is not supported; it is temporarily being exposed to maintain
109109
# backwards compatibility while the SDK structure is updated.
110110
#
111-
# @private
111+
# @api private
112112
#
113113
attr_accessor :instance_id
114114

lib/ldclient-rb/context.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class LDContext
4848
attr_reader :error
4949

5050
#
51-
# @private
51+
# @api private
5252
# @param key [String, nil]
5353
# @param fully_qualified_key [String, nil]
5454
# @param kind [String, nil]

lib/ldclient-rb/events.rb

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,24 +70,24 @@ def stop
7070
MAX_FLUSH_WORKERS = 5
7171
private_constant :MAX_FLUSH_WORKERS
7272

73-
# @private
73+
# @api private
7474
class NullEventProcessor
7575
include EventProcessorMethods
7676
end
7777

78-
# @private
78+
# @api private
7979
class FlushMessage
8080
end
8181

82-
# @private
82+
# @api private
8383
class FlushContextsMessage
8484
end
8585

86-
# @private
86+
# @api private
8787
class DiagnosticEventMessage
8888
end
8989

90-
# @private
90+
# @api private
9191
class SynchronousMessage
9292
def initialize
9393
@reply = Concurrent::Semaphore.new(0)
@@ -102,15 +102,15 @@ def wait_for_completion
102102
end
103103
end
104104

105-
# @private
105+
# @api private
106106
class TestSyncMessage < SynchronousMessage
107107
end
108108

109-
# @private
109+
# @api private
110110
class StopMessage < SynchronousMessage
111111
end
112112

113-
# @private
113+
# @api private
114114
class EventProcessor
115115
include EventProcessorMethods
116116

@@ -226,7 +226,7 @@ def wait_until_inactive
226226
end
227227
end
228228

229-
# @private
229+
# @api private
230230
class EventDispatcher
231231
def initialize(inbox, sdk_key, config, diagnostic_accumulator, event_sender)
232232
@sdk_key = sdk_key
@@ -414,10 +414,10 @@ def send_diagnostic_event(event, diagnostic_event_workers)
414414
end
415415
end
416416

417-
# @private
417+
# @api private
418418
FlushPayload = Struct.new(:events, :summary)
419419

420-
# @private
420+
# @api private
421421
class EventBuffer
422422
def initialize(capacity, logger)
423423
@capacity = capacity
@@ -461,7 +461,7 @@ def clear
461461
end
462462
end
463463

464-
# @private
464+
# @api private
465465
class EventOutputFormatter
466466
FEATURE_KIND = 'feature'
467467
IDENTIFY_KIND = 'identify'

lib/ldclient-rb/expiring_cache.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module LaunchDarkly
66
# * made thread-safe
77
# * removed many unused methods
88
# * reading a key does not reset its expiration time, only writing
9-
# @private
9+
# @api private
1010
class ExpiringCache
1111
def initialize(max_size, ttl)
1212
@max_size = max_size

lib/ldclient-rb/flags_state.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def initialize(valid)
1515
end
1616

1717
# Used internally to build the state map.
18-
# @private
18+
# @api private
1919
def add_flag(flag_state, with_reasons, details_only_if_tracked)
2020
key = flag_state[:key]
2121
@flag_values[key] = flag_state[:value]

lib/ldclient-rb/impl.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ module LaunchDarkly
55
# and subject to change.
66
#
77
# @since 5.5.0
8-
# @private
8+
# @api private
99
#
1010
module Impl
1111
# code is in ldclient-rb/impl/

lib/ldclient-rb/in_memory_store.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ module LaunchDarkly
1010
# The :priority and :get_dependency_keys properties are used by FeatureStoreDataSetSorter
1111
# to ensure data consistency during non-atomic updates.
1212

13-
# @private
13+
# @api private
1414
FEATURES = Impl::DataStore::DataKind.new(namespace: "features", priority: 1).freeze
1515

16-
# @private
16+
# @api private
1717
SEGMENTS = Impl::DataStore::DataKind.new(namespace: "segments", priority: 0).freeze
1818

19-
# @private
19+
# @api private
2020
ALL_KINDS = [FEATURES, SEGMENTS].freeze
2121

2222
#

lib/ldclient-rb/integrations/test_data.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def self.data_source
4242
self.new
4343
end
4444

45-
# @private
45+
# @api private
4646
def initialize
4747
@flag_builders = Hash.new
4848
@current_flags = Hash.new
@@ -56,7 +56,7 @@ def initialize
5656
# Called internally by the SDK to determine what arguments to pass to call
5757
# You do not need to call this method.
5858
#
59-
# @private
59+
# @api private
6060
def arity
6161
2
6262
end
@@ -65,7 +65,7 @@ def arity
6565
# Called internally by the SDK to associate this test data source with an {@code LDClient} instance.
6666
# You do not need to call this method.
6767
#
68-
# @private
68+
# @api private
6969
def call(_, config)
7070
impl = LaunchDarkly::Impl::Integrations::TestData::TestDataSource.new(config.feature_store, self)
7171
@instances_lock.with_write_lock { @instances.push(impl) }
@@ -194,7 +194,7 @@ def use_preconfigured_segment(segment)
194194
end
195195
end
196196

197-
# @private
197+
# @api private
198198
def make_init_data
199199
@lock.with_read_lock do
200200
{
@@ -204,7 +204,7 @@ def make_init_data
204204
end
205205
end
206206

207-
# @private
207+
# @api private
208208
def closed_instance(instance)
209209
@instances_lock.with_write_lock { @instances.delete(instance) }
210210
end

lib/ldclient-rb/integrations/test_data/flag_builder.rb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ class TestData
1212
class FlagBuilder
1313
attr_reader :key
1414

15-
# @private
15+
# @api private
1616
def initialize(key)
1717
@key = key
1818
@on = true
1919
@variations = []
2020
end
2121

22-
# @private
22+
# @api private
2323
def initialize_copy(other)
2424
super(other)
2525
@variations = @variations.clone
@@ -357,7 +357,7 @@ def clear_rules
357357
self
358358
end
359359

360-
# @private
360+
# @api private
361361
def add_rule(rule)
362362
if @rules.nil?
363363
@rules = Array.new
@@ -386,7 +386,7 @@ def boolean_flag
386386
end
387387
end
388388

389-
# @private
389+
# @api private
390390
def build(version)
391391
res = { key: @key,
392392
version: version,
@@ -486,16 +486,16 @@ def build
486486
# Finally, call {#then_return} to finish defining the rule.
487487
#
488488
class FlagRuleBuilder
489-
# @private
489+
# @api private
490490
FlagRuleClause = Struct.new(:contextKind, :attribute, :op, :values, :negate, keyword_init: true) # rubocop:disable Naming/MethodName:
491491

492-
# @private
492+
# @api private
493493
def initialize(flag_builder)
494494
@flag_builder = flag_builder
495495
@clauses = Array.new
496496
end
497497

498-
# @private
498+
# @api private
499499
def intialize_copy(other)
500500
super(other)
501501
@clauses = @clauses.clone
@@ -612,7 +612,7 @@ def then_return(variation)
612612
end
613613
end
614614

615-
# @private
615+
# @api private
616616
def build(ri)
617617
{
618618
id: 'rule' + ri.to_s,
@@ -622,7 +622,7 @@ def build(ri)
622622
end
623623
end
624624

625-
# @private
625+
# @api private
626626
def variation_for_boolean(variation)
627627
variation ? TRUE_VARIATION_INDEX : FALSE_VARIATION_INDEX
628628
end

0 commit comments

Comments
 (0)