Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • whats-open-ios whats-open-ios
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 6
    • Issues 6
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • SRCT
  • whats-open-ioswhats-open-ios
  • Issues
  • #31

Closed
Open
Created Nov 30, 2017 by Zac Wood@zwood2Owner

Add documentation to functions

Summary

We should use Xcode markup to document functions, especially the utility functions, so that the code is easier to understand, maintain, and extend.

Functions and variables should also all follow the Swift API Design Guidelines.

Helpful Links

Xcode markup reference Jazzy documentation generator

Edited Mar 29, 2018 by Zac Wood
Assignee
Assign to
Time tracking