Skip to content

Commit e8d1dcc

Browse files
authored
update API doc (#171)
1 parent 3520cfb commit e8d1dcc

File tree

2 files changed

+1
-3
lines changed

2 files changed

+1
-3
lines changed

Sources/FluidStack/Helper/FluidExtentionViewController.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,6 @@ extension FluidExtentionViewController {
209209
- Parameters:
210210
- transition: You may set ``AnyRemovingTransition/noAnimation`` to disable animation, nil runs transition given view controller provides (if it's ``FluidTransitionViewController``).
211211
- fowardingToParent: Forwards to parent to pop if current stack do not have view controller to pop. No effects if the current stack prevents it by ``FluidStackController/Configuration-swift.struct/preventsFowardingPop``
212-
- cascadesToChildren: if true and if there are view controllers stacked above this view controller, they will be removed as well
213212

214213
- Warning: To run this method to ``FluidStackController`` does not mean to pop the current top view controller.
215214
A way to pop the top view controller:
@@ -250,7 +249,6 @@ extension FluidExtentionViewController {
250249
- Parameters:
251250
- transition: You may set ``AnyRemovingTransition/noAnimation`` to disable animation, nil runs transition given view controller provides (if it's ``FluidTransitionViewController``).
252251
- fowardingToParent: Forwards to parent to pop if current stack do not have view controller to pop. No effects if the current stack prevents it by ``FluidStackController/Configuration-swift.struct/preventsFowardingPop``
253-
- cascadesToChildren: if true and if there are view controllers stacked above this view controller, they will be removed as well
254252

255253
- Warning: To run this method to ``FluidStackController`` does not mean to pop the current top view controller.
256254
A way to pop the top view controller:

Sources/FluidStack/ViewController/FluidStackContext.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public final class FluidStackContext: Equatable {
4949
/// Removes the target view controller in ``FluidStackController``.
5050
/// - Parameter transition: if not nil, it would be used override parameter.
5151
///
52-
/// See detail in ``FluidStackController/removeViewController(_:transition:transitionForBatch:cascadesToChildren:completion:)``
52+
/// See detail in ``FluidStackController/removeViewController(_:removingRule:transition:transitionForBatch:completion:)``
5353
public func removeSelf(
5454
removingRule: RemovingRule = .cascade,
5555
transition: AnyRemovingTransition?,

0 commit comments

Comments
 (0)