Added Documentation.

Author: Satre95

Ternary Search Tree/TST.playground/Contents.swift

@@ -62,7 +62,6 @@ for _ in (1...testCount) {
 
 for aTest in testNums {
     let data = treeOfInts.find(aTest.key)
-    
     if data == nil {
         print("TEST FAILED. Key: \(aTest.key) Data: \(aTest.data)")
     }

Ternary Search Tree/TernarySearchTree.swift

@@ -8,20 +8,45 @@
 
 import Foundation
 
-
+/**
+The Ternary Search Tree (TST) Data structure.
+Data structure uses key-value mappings. Keys are strings used to map to any data element.
+See README for more information.
+*/
 public class TernarySearchTree<Element> {
 
+    /// A reference to the root node of this TST
     var root: TSTNode<Element>?
 
+    /**
+     Standard initializer
+     */
     public init() {}
 
     //MARK: - Insertion
 
+    /**
+    Public insertion method.
+    
+    - parameter data: The value to store in this TST.
+    - parameter key:  The key to associate with this value.
+    
+    - returns: Value indicating insertion success/failure.
+    */
     public func insert(data:Element, withKey key: String) -> Bool{
         return insertNode(&root, withData: data, andKey: key, atIndex: 0)
-        
     }
 
+    /**
+     Helper method for insertion that does the actual legwork. Insertion is performed recursively.
+     
+     - parameter aNode:     The current node to insert below.
+     - parameter data:      The data being inserted.
+     - parameter key:       The key being used to find an insertion ___location for the given data
+     - parameter charIndex: The index of the character in the key string to use to for the next node.
+     
+     - returns: Value indicating insertion success/failure.
+     */
     private func insertNode(inout aNode: TSTNode<Element>?, withData data: Element, andKey key: String, atIndex charIndex: Int) -> Bool {
 
         //sanity check.
@@ -62,12 +87,26 @@ public class TernarySearchTree<Element> {
 
     //MARK: - Finding
 
+    /**
+    Public find method.
+    
+    - parameter key: Search for an object associated with this key.
 
+    - returns: The element, if found. Otherwise, nil.
+    */
     public func find(key:String) -> Element? {
         return findNode(root, withKey: key, atIndex: 0)
     }
 
+    /**
+     Helper method that performs actual legwork of find operation. Implemented recursively.
 
+     - parameter aNode:     The current node being evaluated.
+     - parameter key:       The key being used for the search.
+     - parameter charIndex: The index of the current char in the search key
+     
+     - returns: The element, if found. Nil otherwise.
+     */
     private func findNode(aNode: TSTNode<Element>?, withKey key: String, atIndex charIndex: Int) -> Element? {
 
         //Given key does not exist in tree.