Increase document coverage about ibanimatable HOT 4 OPEN

Coverage with 2.7 release is at 6%.
Would it be useful for me to work on increasing Cocoadocs coverage for the Swift 3 release, or would other documentation be more useful ?

from ibanimatable.

@huntit Thanks, I think we have started adding more and more documentation comments in swift3, the reason why the percentage has decreased for master branch because we have added a lot of ActivityIndicatorAnimation*** classes without documentation comments.

If we add some documentation comments for ActivityIndicatorAnimating like

/// Protocol for all activity indicator classes.
public protocol ActivityIndicatorAnimating {
  /**
   Define the animation for the activity indicator.

   - Parameter layer: The layer to execute the animation
   - Parameter size: The size of the activity indicator.
   - Parameter color: The color of the activity indicator.
   */
  func configAnimation(in layer: CALayer, size: CGSize, color: UIColor)
}

It will improve a lot because the documentation comments will bring to all subclasses.

And we added some documentation comments to swift3 but didn't show up for 2.7 release. A good example is MaskDesignable and MaskType. please have a look at them. I think we don't need to add documentation comments to private and fileprivate methods.

Also, we have a quite comprehensive API document https://github.com/IBAnimatable/IBAnimatable/blob/master/Documentation/APIs.md . I think we can copy them in the code to create documentation comments. Then we don't need this file anymore.

I have sent out the invite to you for joining the IBAnimatable team. You can create feature branch in the IBAnimatable project directly when you work on that. Please have a look at our git process, IBAnimatable/IBAnimatableMaterial#1 , let me know if you have any questions.

from ibanimatable.

@JakeLin Thanks. Yes, coverage has increased to 21% now that I've got jazzy working locally on the Swift 3 branch. Once Xcode 8 goes RTM, Cocoadocs should update their version of jazzy for Swift 3 (support for open, fileprivate, etc). I'll have a look at your git process and start with doc comments for some of the protocols.

from ibanimatable.

@huntit thanks, good to know we are getting better. Our git process is very simple, just master and feature branches. no develop and so on. please let me know if you have any questions.

from ibanimatable.