Skip to content

GitLab

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

Closed
Open
Opened Sep 06, 2018 by Zach Knox@zknoxOwner

Add Documentation to code

Summary

As a developer, I want to have documentation for various aspects of code in order for new developers to get around the code easily.

The most important parts to document are various features beyond the basics of UIKit development. For example, we don't need to document what a UITableViewCell file is, but we should document things we changed and why we did them.

Helpful Links

In order to best document code, we should use Xcode's markup formatting. This can be read by Jazzy to generate docs. https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/

Assignee
Assign to
1.2
Milestone
1.2
Assign milestone
Time tracking
None
Due date
None
Reference: srct/whats-open-ios#43