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

Fixing HeaderDoc invalid documentation #298

Merged

Conversation

glentregoning
Copy link
Contributor

The extension triggers warnings when compiled with CLANG_WARN_DOCUMENTATION_COMMENTS=true.

This PR fixes the warnings and enables this warning by default (to help avoid this issue in future).

@radazzouz radazzouz self-assigned this Jan 31, 2016
@radazzouz
Copy link
Contributor

Thanks so much for taking the time to submit a PR, @glentregoning 👍

The changes look great. However, we prefer to keep Xcode's defaults, as far as Clang warnings are concerned. So could you please remove CLANG_WARN_DOCUMENTATION_COMMENTS = YES; from the project.pbxproj file?

Have an Awesome weekend!

Remove enabling CLANG_WARN_DOCUMENTATION_COMMENTS warning
@glentregoning
Copy link
Contributor Author

Ok @radazzouz I've updated the PR and removed CLANG_WARN_DOCUMENTATION_COMMENTS = YES

@radazzouz
Copy link
Contributor

Thanks for the quick response @glentregoning 👍

Cheers!

radazzouz added a commit that referenced this pull request Jan 31, 2016
Enabling documentation warnings, and fixing HeaderDoc invalid documentation
@radazzouz radazzouz merged commit 647423d into agilebits:master Jan 31, 2016
@radazzouz radazzouz changed the title Enabling documentation warnings, and fixing HeaderDoc invalid documentation Fixing HeaderDoc invalid documentation Jan 31, 2016
radazzouz pushed a commit that referenced this pull request Feb 15, 2016
```
[IMPROVED] Improved compatibility with CocoaPods 1.0.0. {#302}
[IMPROVED] Updated the Javascript code for Web View Filling. {#303}
[IMPROVED] Improved the instructions for the Rich Icons submission in the Best Practice section. {#290}
[IMPROVED] Updated the documentation to mention all the required frameworks to link for projects targeting iOS 7.1 or earlier. {#294, #296}
[IMPROVED] Improved the header documentation. {#298}
[IMPROVED] Listing all the required frameworks in the podspec file. {#297}
[IMPROVED] Removed extra new lines for a clearer code and README. {#293}
[IMPROVED] Removed usless semicolons from Swift code. {#295}

[FIXED] Fixed status bar inconsistencies between the Objective-C and the Swift versions of ACME. {#292}
[FIXED] Fixed outdated header comments for the demo apps. {#299}
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants