Skip to content
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.

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

Sdks 3608 add missing docs #18

Merged
merged 7 commits into from
Dec 10, 2024
Merged

Sdks 3608 add missing docs #18

merged 7 commits into from
Dec 10, 2024

Conversation

vahancouver
Copy link
Contributor

SDKS-3608 [iOS][Ping SDK] Missing docs for public interfaces

Also updated the podspecs and file copyrights

Copy link
Contributor

@spetrov spetrov left a comment

Choose a reason for hiding this comment

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

I found only one typo to be fixed... everything else looks very good! 👍🏻

@@ -11,12 +11,17 @@

import Foundation

/// Struct epresenting the OpenID Connect configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo in "epresenting"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@@ -19,7 +19,7 @@ public protocol Encryptor {
/// - Throws: An error if encryption fails.
func encrypt(data: Data) async throws -> Data

// Decrypts the given data.
/// Decrypts the given data.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should the decrypt function be defined as public?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@spetrov in protocol definitions we cannot specify access modifiers
(XCODE: Protocol requirements implicitly have the same access as the protocol itself)

@@ -19,7 +19,7 @@ public protocol Encryptor {
/// - Throws: An error if encryption fails.
func encrypt(data: Data) async throws -> Data
Copy link
Contributor

Choose a reason for hiding this comment

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

Should the encrypt function be defined as public here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same here

@spetrov spetrov merged commit ff250df into develop Dec 10, 2024
6 checks passed
@spetrov spetrov deleted the SDKS-3608-add-missing-docs branch December 10, 2024 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants