Added nodoc annotations

mchoe · Oct 16, 2019 · 46761e6 · 46761e6
1 parent 77f8112
commit 46761e6
Show file tree

Hide file tree

Showing 126 changed files with 164 additions and 156 deletions.
diff --git a/SwiftSVG/SVG Extensions/CALayer+SVG.swift b/SwiftSVG/SVG Extensions/CALayer+SVG.swift
@@ -60,6 +60,7 @@ public extension CALayer {
         }
     }
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "init(svgURL:parser:completion:)")
     @discardableResult
     convenience init(SVGURL: URL, parser: SVGParser? = nil, completion: @escaping (SVGLayer) -> ()) {
@@ -111,6 +112,7 @@ public extension CALayer {
         }
     }
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "init(svgData:parser:completion:)")
     @discardableResult
     convenience init(SVGData: Data, parser: SVGParser? = nil, completion: @escaping (SVGLayer) -> ()) {

diff --git a/SwiftSVG/SVG Extensions/SVGView.swift b/SwiftSVG/SVG Extensions/SVGView.swift
@@ -91,6 +91,7 @@ open class SVGView : UIView {
         }
     }
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "svgName")
     open var SVGName: String?
 }

diff --git a/SwiftSVG/SVG Extensions/UIBezierPath+SVG.swift b/SwiftSVG/SVG Extensions/UIBezierPath+SVG.swift
@@ -57,7 +57,7 @@ public extension UIBezierPath {
         #endif
     }
 
-
+    /// :nodoc:
     @available(*, deprecated, message: "This method is deprecated. If you want to parse a single path, instantiate a new instance of SVGPath using the SVGPath(singlePathString:) initializer and pass the path string.")
     class func pathWithSVGURL(_ SVGURL: URL) -> UIBezierPath? {
         assert(false, "This method is deprecated")

diff --git a/SwiftSVG/SVG Extensions/UIView+SVG.swift b/SwiftSVG/SVG Extensions/UIView+SVG.swift
@@ -116,6 +116,7 @@ public extension UIView {
         }
     }
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "init(svgNamed:parser:completion:)")
     convenience init(SVGNamed: String, parser: SVGParser? = nil, completion: ((SVGLayer) -> ())? = nil) {
         self.init(svgNamed: SVGNamed, parser: parser, completion: completion)
@@ -144,6 +145,7 @@ public extension UIView {
         }
     }
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "init(svgURL:parser:completion:)")
     convenience init(SVGURL: URL, parser: SVGParser? = nil, completion: ((SVGLayer) -> ())? = nil) {
         self.init(svgURL: SVGURL, parser: parser, completion: completion)
@@ -171,6 +173,7 @@ public extension UIView {
         }
 	}
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "init(svgData:parser:completion:)")
     convenience init(SVGData svgData: Data, parser: SVGParser? = nil, completion: ((SVGLayer) -> ())? = nil) {
         self.init(svgData: svgData, parser: parser, completion: completion)

diff --git a/SwiftSVG/SVG/Parser/NSXMLSVGParser.swift b/SwiftSVG/SVG/Parser/NSXMLSVGParser.swift
@@ -98,6 +98,7 @@ open class NSXMLSVGParser: XMLParser, XMLParserDelegate {
         }
     }
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "init(svgURL:supportedElements:completion:)")
     public convenience init(SVGURL: URL, supportedElements: SVGParserSupportedElements? = nil, completion: ((SVGLayer) -> ())? = nil) {
         self.init(svgURL: SVGURL, supportedElements: supportedElements, completion: completion)
@@ -116,6 +117,7 @@ open class NSXMLSVGParser: XMLParser, XMLParserDelegate {
         self.completionBlock = completion
     }
 
+    /// :nodoc:
     @available(*, deprecated, renamed: "init(svgData:supportedElements:completion:)")
     public convenience init(SVGData: Data, supportedElements: SVGParserSupportedElements? = SVGParserSupportedElements.allSupportedElements, completion: ((SVGLayer) -> ())? = nil) {
         self.init(svgData: SVGData, supportedElements: supportedElements, completion: completion)

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/NSXMLSVGParser.html b/docs/Classes/NSXMLSVGParser.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGCache.html b/docs/Classes/SVGCache.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGCircle.html b/docs/Classes/SVGCircle.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGEllipse.html b/docs/Classes/SVGEllipse.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGGroup.html b/docs/Classes/SVGGroup.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGLayer.html b/docs/Classes/SVGLayer.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGLine.html b/docs/Classes/SVGLine.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGPath.html b/docs/Classes/SVGPath.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGRectangle.html b/docs/Classes/SVGRectangle.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Classes/SVGView.html b/docs/Classes/SVGView.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions.html b/docs/Extensions.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/BinaryFloatingPoint.html b/docs/Extensions/BinaryFloatingPoint.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/CALayer.html b/docs/Extensions/CALayer.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/CAShapeLayer.html b/docs/Extensions/CAShapeLayer.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/CGFloat.html b/docs/Extensions/CGFloat.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/Dictionary.html b/docs/Extensions/Dictionary.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/DispatchQueue.html b/docs/Extensions/DispatchQueue.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/Double.html b/docs/Extensions/Double.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/Float.html b/docs/Extensions/Float.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/FloatingPoint.html b/docs/Extensions/FloatingPoint.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Extensions/String.html b/docs/Extensions/String.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/CanManageAsychronousParsing.html b/docs/Protocols/CanManageAsychronousParsing.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/DelaysApplyingAttributes.html b/docs/Protocols/DelaysApplyingAttributes.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/Fillable.html b/docs/Protocols/Fillable.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/ParsesAsynchronously.html b/docs/Protocols/ParsesAsynchronously.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/PathCommand.html b/docs/Protocols/PathCommand.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/PreviousCommand.html b/docs/Protocols/PreviousCommand.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/SVGContainerElement.html b/docs/Protocols/SVGContainerElement.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/SVGElement.html b/docs/Protocols/SVGElement.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/SVGLayerType.html b/docs/Protocols/SVGLayerType.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/SVGParser.html b/docs/Protocols/SVGParser.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/SVGShapeElement.html b/docs/Protocols/SVGShapeElement.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">

diff --git a/docs/Protocols/StackType.html b/docs/Protocols/StackType.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SwiftSVG Docs
         </a>
-         (79% documented)
+         (80% documented)
       </p>
 
       <p class="header-col--secondary">
-Original file line number
+Diff line change
@@ Expand Up / @@ -91,6 +91,7 @@ open class SVGView : UIView { @@
             }
         }
+        /// :nodoc:
         @available(*, deprecated, renamed: "svgName")
         open var SVGName: String?
     }
@@ Expand Down @@