Swift Docs

swift-docs

/**
A function.

- parameters:
   - alpha: First parameter
   - beta: Second parameter

- parameter alpha: 1st parameter
- parameter beta: 2nd parameter

- Returns: true or false

- Throws: SomeError you might want to catch

- Note: This is based on https://useyourloaf.com/blog/swift-documentation-quick-guide/
- important: Things that users ought to know
- Warning: Things thay users are strongly recommended to know

- Complexity: O(log n) probably
- Precondition: alpha should not be nil
- Postcondition: Everything works
- invariant: Something

- Remark: Similar to notes...
- Attention: Watch out for this!
- Todo: Make it faster
- Bug: This may not work
- experiment: Give it a try maybe

- Version: 1.0.0
- Requires: iOS 12
- Since: iOS 12 also
- Author: Khanh Nguyen
- Authors:
Khanh Nguyen
Khanh Nguyen, again
- Date: Jan 1, 2016
- Copyright: 2016 Acme

- seealso: This doesn't work!!!
*/