search

klarna / klarna-mobile-sdk

Klarna Mobile SDK for iOS
https://docs.klarna.com/mobile-sdk/ios/
Apache License 2.0
29 stars 12 forks source link

Fix documentation comments in iOS framework headers #137

Open artyom-stv opened 2 years ago

artyom-stv commented 2 years ago

Describe the bug There are 12 mistakes in the documentation comments in iOS header files: invalid attribute names following \param.

Build log ``` While building module 'KlarnaMobileSDK' imported from /Users/username/Library/Developer/Xcode/DerivedData/Joom-akeatjfowkfevbbngigumbyiohif/Build/Intermediates.noindex/Joom.build/Debug-iphonesimulator/Joom.build/DerivedSources/Joom-Swift.h:214: In file included from :2: /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:273:12: warning: parameter 'returnUrl' not found in the function declaration [-Wdocumentation] /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:273:12: note: did you mean 'returnURL'? /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ returnURL /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:281:12: warning: parameter 'returnUrl' not found in the function declaration [-Wdocumentation] /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:281:12: note: did you mean 'returnURL'? /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ returnURL /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:340:12: warning: parameter 'returnUrl' not found in the function declaration [-Wdocumentation] /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:340:12: note: did you mean 'returnURL'? /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ returnURL /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:348:12: warning: parameter 'returnUrl' not found in the function declaration [-Wdocumentation] /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:348:12: note: did you mean 'returnURL'? /// \param returnUrl Your apps custom URL scheme CFBundleURLSchemes. ^~~~~~~~~ returnURL /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:577:12: warning: parameter 'eventListener' not found in the function declaration [-Wdocumentation] /// \param eventListener A listener that will receive events from the SDK. ^~~~~~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:577:12: note: did you mean 'klarnaEventListener'? /// \param eventListener A listener that will receive events from the SDK. ^~~~~~~~~~~~~ klarnaEventListener /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:579:12: warning: parameter 'fullscreenEventListener' not found in the function declaration [-Wdocumentation] /// \param fullscreenEventListener Listener that will notify fullscreen events. ^~~~~~~~~~~~~~~~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:579:12: note: did you mean 'klarnaEventListener'? /// \param fullscreenEventListener Listener that will notify fullscreen events. ^~~~~~~~~~~~~~~~~~~~~~~ klarnaEventListener /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:589:12: warning: parameter 'eventListener' not found in the function declaration [-Wdocumentation] /// \param eventListener A listener that will receive events from the SDK. ^~~~~~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:589:12: note: did you mean 'klarnaEventListener'? /// \param eventListener A listener that will receive events from the SDK. ^~~~~~~~~~~~~ klarnaEventListener /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:591:12: warning: parameter 'fullscreenEventListener' not found in the function declaration [-Wdocumentation] /// \param fullscreenEventListener Listener that will notify fullscreen events. ^~~~~~~~~~~~~~~~~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:591:12: note: did you mean 'klarnaEventListener'? /// \param fullscreenEventListener Listener that will notify fullscreen events. ^~~~~~~~~~~~~~~~~~~~~~~ klarnaEventListener /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:957:12: warning: parameter 'delegate' not found in the function declaration [-Wdocumentation] /// \param delegate A listener object that will receive events from this view. ^~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:957:12: note: did you mean 'eventListener'? /// \param delegate A listener object that will receive events from this view. ^~~~~~~~ eventListener /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:973:12: warning: parameter 'delegate' not found in the function declaration [-Wdocumentation] /// \param delegate A listener object that will receive events from this view. ^~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:973:12: note: did you mean 'eventListener'? /// \param delegate A listener object that will receive events from this view. ^~~~~~~~ eventListener /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:987:12: warning: parameter 'delegate' not found in the function declaration [-Wdocumentation] /// \param delegate A listener object that will receive events from this view. ^~~~~~~~ /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:987:12: note: did you mean 'eventListener'? /// \param delegate A listener object that will receive events from this view. ^~~~~~~~ eventListener /path/to/project/Carthage/Build/iOS/KlarnaMobileSDK.framework/Headers/KlarnaMobileSDK-Swift.h:1003:12: warning: parameter 'delegate' not found in the function declaration [-Wdocumentation] /// \param delegate A listener object that will receive events from this view. ^~~~~~~~ 12 warnings generated. ```

To Reproduce Steps to reproduce the behavior:

  1. Import KlarnaMobileSDK
  2. See warnings (-Wdocumentation) that cannot be suppressed

Expected behavior There are no mistakes that cause warnings.

Screenshots

A screenshot of Xcode warnings

Device and version:

Merchant Name Joom

Impact Level These are the only warnings in our project. We need to keep the project free of warnings to get new [important] warnings noticed immediately.

Additional context The SDK is integrated via Carthage.

artyom-stv commented 2 years ago

Hi!

Is there any progress with this issue?