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

Fix documentation comments in iOS framework headers #137

Open
artyom-stv opened this issue Apr 13, 2022 · 1 comment
Open

Fix documentation comments in iOS framework headers #137

artyom-stv opened this issue Apr 13, 2022 · 1 comment
Labels
investigating Bug/feature is being investigated. ios

Comments

@artyom-stv
Copy link

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 <module-includes>: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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
/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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
           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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
/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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
           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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
/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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
           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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
/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 <code>CFBundleURLSchemes</code>.
           ^~~~~~~~~
           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:

  • Device: -
  • OS version: -
  • Klarna In-App SDK version 2.1.5

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.

@polar133 polar133 added investigating Bug/feature is being investigated. ios labels Apr 13, 2022
@artyom-stv
Copy link
Author

Hi!

Is there any progress with this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
investigating Bug/feature is being investigated. ios
Projects
None yet
Development

No branches or pull requests

2 participants