Skip to content

Fix DocC documentation #370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tinder-cfuller merged 2 commits into from
Mar 15, 2024
Merged

Fix DocC documentation #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47ccd0f
Fix UIView+Layout documentation
tinder-cfuller Mar 9, 2024
80983c7
Treat DocC warnings as errors
tinder-cfuller Mar 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ docs:
xcodebuild docbuild \
-scheme "$(target)" \
-destination "$(destination)" \
-derivedDataPath "$(DERIVED_DATA_PATH)"
-derivedDataPath "$(DERIVED_DATA_PATH)" \
OTHER_DOCC_FLAGS="--warnings-as-errors"
@find "$(DERIVED_DATA_PATH)" \
-type d \
-name "$(target).doccarchive" \
Expand Down
7 changes: 4 additions & 3 deletions Sources/Layout/UIKit/UIView+Layout.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ extension UIView {
/// distinct states.
///
/// - Note: Use ``layout(metrics:_:)`` to create a layout with one item and use ``layout(metrics:items:)`` for
/// multiple items. Call ``Layout/addItems(_:)-59mxv`` to add more items to the layout.
/// multiple items. Use ``Layout/addItem(_:)`` or ``Layout/addItems(items:)`` to add additional items to
Copy link
Contributor

@tinder-emanharoutunian tinder-emanharoutunian Mar 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious—how we maintained linking behavior in the docs without the Xcode-provided ID appended to the method?

Copy link
Collaborator Author

@tinder-cfuller tinder-cfuller Mar 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those methods were renamed, but the rename PR did not update these docs. With the rename there is no ambiguity, therefore the IDs are not necessary.

/// the layout.
///
/// - Important: The ``Layout/activate()`` method must be called to activate the constraints of the layout.
/// Calling ``Layout/deactivate()`` does not hide or remove subviews.
Expand Down Expand Up @@ -51,7 +52,7 @@ extension UIView {
/// ```
///
/// - Note: Use this method to create a layout with one item and use ``layout(metrics:items:)`` for multiple items.
/// Call ``Layout/addItems(_:)-59mxv`` to add more items to the layout.
/// Use ``Layout/addItem(_:)`` or ``Layout/addItems(items:)`` to add additional items to the layout.
///
/// - Important: The ``Layout/activate()`` method must be called to activate the constraints of the layout.
/// Calling ``Layout/deactivate()`` does not hide or remove subviews.
Expand Down Expand Up @@ -93,7 +94,7 @@ extension UIView {
/// ```
///
/// - Note: Use this method to create a layout with multiple items and use ``layout(metrics:_:)`` for a single item.
/// Call ``Layout/addItems(_:)-59mxv`` to add more items to the layout.
/// Use ``Layout/addItem(_:)`` or ``Layout/addItems(items:)`` to add additional items to the layout.
///
/// - Important: The ``Layout/activate()`` method must be called to activate the constraints of the layout.
/// Calling ``Layout/deactivate()`` does not hide or remove subviews.
Expand Down