[GH-ISSUE #470] Add code documentation to most important types, methods and properties #308

Closed
opened 2026-03-03 16:47:34 +03:00 by kerem · 0 comments
Owner

Originally created by @phlebotinum on GitHub (Jun 16, 2018).
Original GitHub issue: https://github.com/OAuthSwift/OAuthSwift/issues/470

Description:

Is this desirable for the core contributers, or not ? Just a matter of workload ? Help and PRs wanted ?

Note: If this is wanted then I would be willing to put a bit of time into this, but i am not an expert on the framework and the subject so i personally could not document everything that i would like to see documented correctly right away. I could try as best as i can but would then need someone to seriously check it and i most likely would have questions i could put into WIP PRs and with feedback to them i could then continue. Let me know. Cheers

OAuth Provider? (Twitter, Github, ..):

-Any

OAuth Version:

  • Version 1
  • Version 2

OS (Please fill the version) :

  • iOS :
  • OSX :
  • TVOS :
  • WatchOS :

Installation method:

  • Carthage
  • CocoaPods
  • Manually

Library version:

  • head
  • v1.2.1
  • v1.2 (Swift 4.0)
  • v1.0.0
  • v0.6
  • other: (Please fill in the version you are using.)

Xcode version:

  • 9.3 (Swift 4.1)

  • 9.0 (Swift 4.0)

  • 9.0 (Swift 3.2)

  • 8.x (Swift 3.x)

  • 8.0 (Swift 2.3)

  • 7.3.1

  • other: (Please fill in the version you are using.)

  • objective c

Originally created by @phlebotinum on GitHub (Jun 16, 2018). Original GitHub issue: https://github.com/OAuthSwift/OAuthSwift/issues/470 ### Description: Is this desirable for the core contributers, or not ? Just a matter of workload ? Help and PRs wanted ? _Note: If this is wanted then I would be willing to put a bit of time into this, but i am not an expert on the framework and the subject so i personally could not document everything that i would like to see documented correctly right away. I could try as best as i can but would then need someone to seriously check it and i most likely would have questions i could put into WIP PRs and with feedback to them i could then continue. Let me know. Cheers_ ### OAuth Provider? (Twitter, Github, ..): -Any ### OAuth Version: - [X] Version 1 - [X] Version 2 ### OS (Please fill the version) : - [x] iOS : - [X] OSX : - [X] TVOS : - [X] WatchOS : ### Installation method: - [ ] Carthage - [ ] CocoaPods - [ ] Manually ### Library version: - [X] head - [ ] v1.2.1 - [ ] v1.2 (Swift 4.0) - [ ] v1.0.0 - [ ] v0.6 - [ ] other: (Please fill in the version you are using.) ### Xcode version: - [X] 9.3 (Swift 4.1) - [ ] 9.0 (Swift 4.0) - [ ] 9.0 (Swift 3.2) - [ ] 8.x (Swift 3.x) - [ ] 8.0 (Swift 2.3) - [ ] 7.3.1 - [ ] other: (Please fill in the version you are using.) - [ ] objective c
kerem closed this issue 2026-03-03 16:47:35 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/OAuthSwift#308
No description provided.