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

Add generated API documentation to repo #145

Merged
merged 1 commit into from Jun 22, 2022
Merged

Conversation

evansims
Copy link
Member

Changes

This PR adds the API documentation generated by the bundle exec fastlane ios build_docs command, added in #144

References

See internal ticket SDK-3450

Testing

Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If helpful, please include manual testing steps as well.

  • This change adds unit test coverage (or why not)
  • This change has been tested on the latest version of the platform/language or why not

Checklist

@evansims evansims changed the base branch from master to fa June 21, 2022 22:03
@evansims evansims added documentation This adds, fixes or improves documentation review:small Small review review:tiny Tiny review and removed review:small Small review labels Jun 21, 2022
@evansims evansims marked this pull request as ready for review June 21, 2022 22:04
@evansims evansims requested a review from a team as a code owner June 21, 2022 22:04
@Widcket Widcket merged commit 6cdf613 into fa Jun 22, 2022
@Widcket Widcket deleted the docs/add-api-documentation branch June 22, 2022 00:51
Widcket added a commit that referenced this pull request Jul 20, 2022
* Add migration guide [SDK-3393] (#127)

Add migration guide

* Remove license header from source files [SDK-3389] (#126)

Remove license header

* Update year in license file (#128)

* Add `.swiftpm` directory to `.gitignore` (#131)

Add `.swiftpm` to `.gitignore`

* Add CONTRIBUTING.md (#130)

* Drop old platform versions [SDK-3387] (#129)

* Drop old platform versions

* Remove preprocessor macros and compatibility code

* Remove obsolete preprocessor macros

* Use accesibility config when neither iOS nor macOS

* Remove unnecessary preprocessor macros

* Remove extra blank line at the end of the file

* Restore Touch ID case

* Remove leftover nested if

* Update README [SDK-3416] (#135)

* Remove deprecated method [SDK-3413] (#132)

* Remove deprecated method

* Add change to the migration guide

* Remove usage of deprecated properties [SDK-3414] (#133)

* Remove usage of deprecated APIs

* Remove enum cases

* Remove usage of enum cases

* Update V1_MIGRATION_GUIDE.md

Co-authored-by: Steve Hobbs <steve.hobbs@auth0.com>

Co-authored-by: Steve Hobbs <steve.hobbs@auth0.com>

* Add support policy [SDK-3420] (#138)

* Fix typo in property name (#137)

* Remove obsolete functionality [SDK-3419] (#136)

* [SDK-3434] Update issues templates (#140)

* [SDK-3434] Migrate GitHub issue templates

* Update config.yml

* Update config.yml

* Add note about the Responsible Disclosure Program to bug reports template.

* Remove "FAQ.md" reference, as there is no file

* Update .github/ISSUE_TEMPLATE/Bug Report.yml

* Update .github/ISSUE_TEMPLATE/Feature Request.yml

* Update .github/ISSUE_TEMPLATE/Bug Report.yml

* Update .github/ISSUE_TEMPLATE/Feature Request.yml

* Update .github/ISSUE_TEMPLATE/config.yml

* Update .github/ISSUE_TEMPLATE/config.yml

* Update checkbox grouping

* Update Pull Request template

Co-authored-by: Rita Zerrizuela <zeta@widcket.com>

* Migrate to Swift [SDK-3428] (#139)

* Migrate to Swift

* Add test case

* Integrate SwiftLint

* Add .swiftlint.yml

* Fix tests

* Add API docs

* Update migration guide

* Remove leftover comments

* Update library description

* Add snippets to the API docs

* Drop Xcode 12.x and its older simulators

* Add item to the migration guide

* Drop support for old Swift versions [SDK-3444] (#141)

* Add missing unit tests (#142)

* Add missing tests

* Remove extra whitespace

* Add missing import for SPM

* Apply recommended Xcode 14 settings (#143)

* [SDK-3450] API Documentation Generation (#144)

* Add generated API documentation to repo (#145)

* Add support for iCloud synchronization (#146)

* Add support for iCould synchronization

* Update API docs

* Add unit tests for queries (#147)

Test queries

* Improve API docs generation (#148)

* Fix typos in tests (#149)

* Make `context` parameter optional (#151)

* Re-generate API docs (#152)

* Complete README and Migration Guide [SDK-3397] (#150)

* Add support for custom attributes (#153)

* Replace OSX with macOS in schemes and targets (#154)

Replace OSX with macOS

* Release 1.0.0-fa.0 (#155)

* Add fa to Podspec version (#156)

* Fix 'access group' capitalization (#158)

* Update API docs (#159)

* Use Codecov orb (#161)

* Create .semgrepignore

* Add placeholders to issue forms (#162)

* Update README for GA [SDK-3500] (#163)

Update the README for GA

* Merge `master` into `fa` (#164)

Co-authored-by: Steve Hobbs <steve.hobbs@auth0.com>
Co-authored-by: Evan Sims <evan.sims@auth0.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This adds, fixes or improves documentation review:tiny Tiny review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants