danielebogo/DBCamera

Better documentation

Open

#152 opened on May 7, 2015

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Objective-C (256 forks)github user discovery
Hacktoberfest

Repository metrics

Stars
 (1,258 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi,

first thank you for you work! I just started playing around with DBCamera and I think it's unnecessarily hard to figure out which component is doing what. For example the difference between DBCameraViewController and DBCameraContainerViewController isn't apparent nor is it obvious why or when I'd need one, the other or both.

I also wasn't able to spot a difference between the "Open Camera", "Open Camera without Seque" and "Open Camera without Container" examples.

The class level documentation unfortunately doesn't help much either

/**
 *  DBCameraContainerViewController
 */
@interface DBCameraContainerViewController : UIViewController <DBCameraViewControllerSettings>

Maybe it's possible to describe the overall structure and architecture somewhere or document the goal and task of the high level components a in a little more detail?

That'd be terrific!

Contributor guide

Research direction
Explain the difference between DBCameraViewController and DBCameraContainerViewController by examining their interfaces and roles in the library's architecture. Provide a high level overview of how these components interact and when to use each. Clarify the examples by describing the purpose of each demonstration.
Tech stack
objective c
Domain
mobile
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Objective CiOS development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70