Add source documentation for the Toknizer classes

HTMLKit/HTMLTokenizer.h

@@ -6,23 +6,45 @@
 //  Copyright (c) 2014 BrainCookie. All rights reserved.
 //
 
+///------------------------------------------------------
+/// HTMLKit private header
+///------------------------------------------------------
+
 #import <Foundation/Foundation.h>
 #import "HTMLToken.h"
 #import "HTMLTokenizerStates.h"
 
+@class HTMLParser;
+
 /**
  * HTML Tokenizer
  * https://html.spec.whatwg.org/multipage/syntax.html#tokenization
  */
-
-@class HTMLParser;
-
 @interface HTMLTokenizer : NSEnumerator
 
+/** @brief The underlying string with which this tokenizer was initialized. */
 @property (nonatomic, readonly) NSString *string;
+
+/**
+ The current tokenizer state.
+
+ @see HTMLTokenizerState
+ */
 @property (nonatomic, assign) HTMLTokenizerState state;
+
+/**
+ The associated HTML Parser instance.
+ 
+ @see HTMLParser
+ */
 @property (nonatomic, weak, readonly) HTMLParser *parser;
 
+/**
+ Initializes a new Tokenizer with the given string.
+
+ @param string The HTML string
+ @returns A new instance of the Tokenizer.
+ */
 - (instancetype)initWithString:(NSString *)string;
 
 @end