Fix "return" attribute in source code documentation

@returns is ignored by jazzy

HTMLKit/CSSAttributeSelector.h

@@ -35,7 +35,7 @@ NS_ASSUME_NONNULL_BEGIN
  Intializes and returns a CSS class selector.
 
  @param className The class name to match.
- @returns A new instance of class selector.
+ @return A new instance of class selector.
  */
 + (instancetype)classSelector:(NSString *)className;
 
@@ -43,7 +43,7 @@ NS_ASSUME_NONNULL_BEGIN
  Intializes and returns a CSS id selector.
 
  @param elementId The element id to match.
- @returns A new instance of id selector.
+ @return A new instance of id selector.
  */
 + (instancetype)idSelector:(NSString *)elementId;
 
@@ -51,7 +51,7 @@ NS_ASSUME_NONNULL_BEGIN
  Intializes and returns a CSS has-attribute selector.
 
  @param attributeName The attribute name to match.
- @returns A new instance of has-attribute selector.
+ @return A new instance of has-attribute selector.
  */
 + (instancetype)hasAttributeSelector:(NSString *)attributeName;
 
@@ -61,7 +61,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param type The selector type.
  @param name The attribute name to match.
  @param value The value to match.
- @returns A new instance of attribute selector.
+ @return A new instance of attribute selector.
  */
 - (instancetype)initWithType:(CSSAttributeSelectorType)type
 			   attributeName:(NSString *)name

HTMLKit/CSSCombinatorSelector.h

@@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes and returns a CSS child-of-element selector, e.g. 'div > p'
 
  @param selector The selector matching the parent element.
- @returns A new instance of the child of element selector.
+ @return A new instance of the child of element selector.
  */
 + (instancetype)childOfElementCombinator:(CSSSelector *)selector;
 
@@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes and returns a CSS descendant-of-element selector, e.g. 'div p'
 
  @param selector The selector matching the ancestor element.
- @returns A new instance of the descendant of element selector.
+ @return A new instance of the descendant of element selector.
  */
 + (instancetype)descendantOfElementCombinator:(CSSSelector *)selector;
 
@@ -35,7 +35,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes and returns a CSS adjacent sibling selector, e.g. 'p + a'
 
  @param selector The selector matching the adjacent sibling element.
- @returns A new instance of the adjacent sibling selector.
+ @return A new instance of the adjacent sibling selector.
  */
 + (instancetype)adjacentSiblingCombinator:(CSSSelector *)selector;
 
@@ -43,7 +43,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes and returns a CSS general sibling selector, e.g. 'p ~ a'
 
  @param selector The selector matching the general sibling element.
- @returns A new instance of the general sibling selector.
+ @return A new instance of the general sibling selector.
  */
 + (instancetype)generalSiblingCombinator:(CSSSelector *)selector;
 

HTMLKit/CSSCompoundSelector.h

@@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes and returns a new compound selector matching only elements that match all of the specified selectors.
 
  @param selectors The selectors list.
- @returns A new instance of the All-Of selector.
+ @return A new instance of the All-Of selector.
  */
 + (instancetype)andSelector:(NSArray<CSSSelector *> *)selectors;
 
@@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes and returns a new compound selector matching all elements that match at least one of the specified selectors.
 
  @param selectors The selectors list.
- @returns A new instance of the Any-Of selector.
+ @return A new instance of the Any-Of selector.
  */
 + (instancetype)orSelector:(NSArray<CSSSelector *> *)selectors;
 

HTMLKit/CSSInputStream.h

@@ -31,7 +31,7 @@
  http://www.w3.org/TR/css-syntax-3/#consume-a-string-token
  http://www.w3.org/TR/css-syntax-3/#would-start-an-identifier
 
- @returns A consumed identifier, `nil` if the stream doesn't start with a valid identifier.
+ @return A consumed identifier, `nil` if the stream doesn't start with a valid identifier.
  */
 - (NSString *)consumeIdentifier;
 
@@ -39,7 +39,7 @@
  Consumes characters until the specified code-point is met.
 
  @param endingCodePoint The code-point at which the input stream stops consuming.
- @returns The consumed string, `nil` nothing was consumed.
+ @return The consumed string, `nil` nothing was consumed.
  */
 - (NSString *)consumeStringWithEndingCodePoint:(UTF32Char)endingCodePoint;
 
@@ -48,14 +48,14 @@
  http://www.w3.org/TR/css-syntax-3/#consume-an-escaped-code-point
  http://www.w3.org/TR/css-syntax-3/#starts-with-a-valid-escape
 
- @returns The value of the escaped code-point.
+ @return The value of the escaped code-point.
  */
 - (UTF32Char)consumeEscapedCodePoint;
 
 /**
  Consumes a CSS selector combinator.
  
- @returns The consumed combinator, `nil` if nothing was consumed.
+ @return The consumed combinator, `nil` if nothing was consumed.
  */
 - (NSString *)consumeCombinator;
 

HTMLKit/CSSNthExpressionSelector.h

@@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new CSS nth-child selector, e.g. ':nth-child(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Child selector for the specified expression.
+ @return Nth-Child selector for the specified expression.
 
  @see CSSNthExpression
  */
@@ -41,7 +41,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new CSS nth-last-child selector, e.g. ':nth-last-child(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Last-Child selector for the specified expression.
+ @return Nth-Last-Child selector for the specified expression.
 
  @see CSSNthExpression
  */
@@ -51,7 +51,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new CSS nth-of-type selector, e.g. ':nth-of-type(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Of-Type selector for the specified expression.
+ @return Nth-Of-Type selector for the specified expression.
 
  @see CSSNthExpression
  */
@@ -61,7 +61,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new CSS nth-last-of-type selector, e.g. ':nth-last-of-type(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Last-Of-Type selector for the specified expression.
+ @return Nth-Last-Of-Type selector for the specified expression.
 
  @see CSSNthExpression
  */

HTMLKit/CSSPseudoClassSelector.h

@@ -25,7 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param className The pseudo class name.
  @param selector The underlying selector.
- @returns A new instance of a pseudo-class selector.
+ @return A new instance of a pseudo-class selector.
  */
 - (instancetype)initWithClassName:(NSString *)className selector:(CSSSelector *)selector;
 

HTMLKit/CSSPseudoFunctionSelector.h

@@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes and returns a CSS nagation selector, e.g. ':not(div)'
 
  @param selector The selector which should be negated.
- @returns A new instance of the negation selector.
+ @return A new instance of the negation selector.
  */
 + (instancetype)notSelector:(CSSSelector *)selector;
 
@@ -29,7 +29,7 @@ NS_ASSUME_NONNULL_BEGIN
  @discussion 'div:has(p)' matches all <div> elements which have a descendant <p> element.
 
  @param selector The selector matching a descendant element.
- @returns A new instance of the has-descendant selector.
+ @return A new instance of the has-descendant selector.
  */
 + (instancetype)hasSelector:(CSSSelector *)selector;
 

HTMLKit/CSSSelector.h

@@ -74,7 +74,7 @@ extern NSString * _Nonnull NSStringFromNthExpression(CSSNthExpression expression
  Initializes and returns a new instance of CSS Selector.
  
  @param string The selector string which will be parsed.
- @returns A new instance of a parsed CSS Selector, `nil` if the string is not a valid selector string.
+ @return A new instance of a parsed CSS Selector, `nil` if the string is not a valid selector string.
  */
 + (nullable instancetype)selectorWithString:(NSString *)stirng;
 

HTMLKit/CSSSelectorBlock.h

@@ -22,7 +22,7 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param name The name of the selector.
  @param block The block that should match desired elements.
- @returns A new instance of the block-based selector.
+ @return A new instance of the block-based selector.
  */
 - (instancetype)initWithName:(NSString *)name block:(BOOL (^)(HTMLElement *))block;
 

HTMLKit/CSSSelectorParser.h

@@ -25,7 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param string The CSS3 selector string.
  @param error If an error occurs, upon return contains an `NSError` object that describes the problem.
- @returns A parsed CSSSelector, `nil` if an error occurred.
+ @return A parsed CSSSelector, `nil` if an error occurred.
 
  @see CSSelector
  */

HTMLKit/CSSSelectors.h

@@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Universal CSS selector: '*'
 
- @returns The universal CSS selector.
+ @return The universal CSS selector.
  */
 extern CSSSelector * universalSelector();
 
@@ -32,7 +32,7 @@ extern CSSSelector * universalSelector();
  CSS type selector, e.g. 'div', 'p', ...etc.
  
  @param type The element type.
- @returns Type selector for the specified type.
+ @return Type selector for the specified type.
  */
 extern CSSSelector * typeSelector(NSString *type);
 
@@ -42,7 +42,7 @@ extern CSSSelector * typeSelector(NSString *type);
  CSS id selector, e.g. '#someId'
 
  @param elementId The element id.
- @returns Id selector for the specified element id.
+ @return Id selector for the specified element id.
  */
 extern CSSSelector * idSelector(NSString *elementId);
 
@@ -50,7 +50,7 @@ extern CSSSelector * idSelector(NSString *elementId);
  CSS class selector, e.g. '.someClass'
 
  @param className The class name.
- @returns Class selector for the specified class name.
+ @return Class selector for the specified class name.
  */
 extern CSSSelector * classSelector(NSString *className);
 
@@ -58,7 +58,7 @@ extern CSSSelector * classSelector(NSString *className);
  CSS has-attribute selector, e.g. '[href]'
 
  @param attribute The attribute.
- @returns Has-Attribute selector for the specified attribute.
+ @return Has-Attribute selector for the specified attribute.
  */
 extern CSSSelector * hasAttributeSelector(NSString *attribute);
 
@@ -68,7 +68,7 @@ extern CSSSelector * hasAttributeSelector(NSString *attribute);
  @param type The attribute selector type.
  @param attribute The attribute.
  @param value The value of the attribute.
- @returns Attribute selector.
+ @return Attribute selector.
  
  @see CSSAttributeSelectorType
  */
@@ -82,7 +82,7 @@ extern CSSSelector * attributeSelector(CSSAttributeSelectorType type,
  CSS nth-child selector, e.g. ':nth-child(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Child selector for the specified expression.
+ @return Nth-Child selector for the specified expression.
 
  @see CSSNthExpression
  */
@@ -92,7 +92,7 @@ extern CSSSelector * nthChildSelector(CSSNthExpression expression);
  CSS nth-last-child selector, e.g. ':nth-last-child(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Last-Child selector for the specified expression.
+ @return Nth-Last-Child selector for the specified expression.
 
  @see CSSNthExpression
  */
@@ -102,7 +102,7 @@ extern CSSSelector * nthLastChildSelector(CSSNthExpression expression);
  CSS nth-of-type selector, e.g. ':nth-of-type(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Of-Type selector for the specified expression.
+ @return Nth-Of-Type selector for the specified expression.
 
  @see CSSNthExpression
  */
@@ -112,7 +112,7 @@ extern CSSSelector * nthOfTypeSelector(CSSNthExpression expression);
  CSS nth-last-of-type selector, e.g. ':nth-last-of-type(2n+3)'
 
  @param expression The nth-expression.
- @returns Nth-Last-Of-Type selector for the specified expression.
+ @return Nth-Last-Of-Type selector for the specified expression.
 
  @see CSSNthExpression
  */
@@ -123,7 +123,7 @@ extern CSSSelector * nthLastOfTypeSelector(CSSNthExpression expression);
  
  This is analogous to ':nth-child(2n+1)'
 
- @returns Odd-Child selector.
+ @return Odd-Child selector.
  */
 extern CSSSelector * oddSelector();
 
@@ -132,49 +132,49 @@ extern CSSSelector * oddSelector();
 
  This is analogous to ':nth-child(2n)'
 
- @returns Even-Child selector.
+ @return Even-Child selector.
  */
 extern CSSSelector * evenSlector();
 
 /**
  CSS first-child selector: ':nth-child(1)'
 
- @returns First-Child selector.
+ @return First-Child selector.
  */
 extern CSSSelector * firstChildSelector();
 
 /**
  CSS first-child selector: ':nth-last-child(1)'
 
- @returns First-Child selector.
+ @return First-Child selector.
  */
 extern CSSSelector * lastChildSelector();
 
 /**
  CSS first-of-type selector: ':nth-first-of-type(1)'
 
- @returns First-Of-Type selector.
+ @return First-Of-Type selector.
  */
 extern CSSSelector * firstOfTypeSelector();
 
 /**
  CSS last-of-type selector: ':nth-last-of-type(1)'
 
- @returns Last-Of-Type selector.
+ @return Last-Of-Type selector.
  */
 extern CSSSelector * lastOfTypeSelector();
 
 /**
  CSS only-child selector: ':first-child:last-child'
 
- @returns Only-Child selector.
+ @return Only-Child selector.
  */
 extern CSSSelector * onlyChildSelector();
 
 /**
  CSS only-of-type selector: ':first-of-type:last-of-type'
 
- @returns Only-Of-Type selector.
+ @return Only-Of-Type selector.
  */
 extern CSSSelector * onlyOfTypeSelector();
 
@@ -184,7 +184,7 @@ extern CSSSelector * onlyOfTypeSelector();
  CSS child-of-element selector, e.g. 'div > p'
 
  @param selector The selector matching the parent element.
- @returns A child of element selector.
+ @return A child of element selector.
  */
 extern CSSSelector * childOfElementSelector(CSSSelector *selector);
 
@@ -192,7 +192,7 @@ extern CSSSelector * childOfElementSelector(CSSSelector *selector);
  CSS descendant-of-element selector, e.g. 'div p'
 
  @param selector The selector matching the ancestor element.
- @returns A descendant of element selector.
+ @return A descendant of element selector.
  */
 extern CSSSelector * descendantOfElementSelector(CSSSelector *selector);
 
@@ -200,7 +200,7 @@ extern CSSSelector * descendantOfElementSelector(CSSSelector *selector);
  CSS adjacent sibling selector, e.g. 'p + a'
 
  @param selector The selector matching the adjacent sibling element.
- @returns A adjacent sibling selector.
+ @return A adjacent sibling selector.
  */
 extern CSSSelector * adjacentSiblingSelector(CSSSelector *selector);
 
@@ -208,7 +208,7 @@ extern CSSSelector * adjacentSiblingSelector(CSSSelector *selector);
  CSS general sibling selector, e.g. 'p ~ a'
 
  @param selector The selector matching the general sibling element.
- @returns A general sibling selector.
+ @return A general sibling selector.
  */
 extern CSSSelector * generalSiblingSelector(CSSSelector *selector);
 
@@ -218,7 +218,7 @@ extern CSSSelector * generalSiblingSelector(CSSSelector *selector);
  CSS nagation selector: ':not(div)'
  
  @param selector The selector which should be negated.
- @returns A negation selector.
+ @return A negation selector.
  */
 extern CSSSelector * not(CSSSelector *selector);
 
@@ -228,7 +228,7 @@ extern CSSSelector * not(CSSSelector *selector);
  @discussion 'div:has(p)' matches all <div> elements which have a descendant <p> element.
 
  @param selector The selector matching a descendant element.
- @returns A has-descendant selector.
+ @return A has-descendant selector.
  */
 extern CSSSelector * has(CSSSelector *selector);
 
@@ -238,7 +238,7 @@ extern CSSSelector * has(CSSSelector *selector);
  A compound selector matching only elements that match all of the specified selectors.
 
  @param selectors The selectors list.
- @returns All-Of selector.
+ @return All-Of selector.
  */
 extern CSSSelector * allOf(NSArray<CSSSelector *> *selectors);
 
@@ -246,7 +246,7 @@ extern CSSSelector * allOf(NSArray<CSSSelector *> *selectors);
  A compound selector matching all elements that match at least one of the specified selectors.
 
  @param selectors The selectors list.
- @returns Any-Of selector.
+ @return Any-Of selector.
  */
 extern CSSSelector * anyOf(NSArray<CSSSelector *> *selectors);
 
@@ -259,7 +259,7 @@ extern CSSSelector * anyOf(NSArray<CSSSelector *> *selectors);
 
  @param name The name of the selector.
  @param selector The underlying selector.
- @returns A named-pseudo selector.
+ @return A named-pseudo selector.
  */
 extern CSSSelector * namedPseudoSelector(NSString *name, CSSSelector *selector);
 
@@ -270,7 +270,7 @@ extern CSSSelector * namedPseudoSelector(NSString *name, CSSSelector *selector);
 
  @param name The name of the selector.
  @param acceptBlock The block which provides the implementation for the accept-element logic.
- @returns A named-block selector.
+ @return A named-block selector.
  */
 extern CSSSelector * namedBlockSelector(NSString *name, BOOL (^ acceptBlock)(HTMLElement *element));
 

HTMLKit/CSSStructuralPseudoSelectors.h

@@ -11,102 +11,102 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- @returns Root element selector: ':root'
+ @return Root element selector: ':root'
  */
 extern CSSSelector * rootSelector();
 
 /**
- @returns Empy element selector: ':empty'
+ @return Empy element selector: ':empty'
  */
 extern CSSSelector * emptySelector();
 
 /**
- @returns A parent element selector: ':parent'
+ @return A parent element selector: ':parent'
  */
 extern CSSSelector * parentSelector();
 
 /**
- @returns A button element selector: ':button'
+ @return A button element selector: ':button'
  */
 extern CSSSelector * buttonSelector();
 
 /**
- @returns A checkbox element selector: ':checkbox'
+ @return A checkbox element selector: ':checkbox'
  */
 extern CSSSelector * checkboxSelector();
 
 /**
- @returns A file element selector: ':file'
+ @return A file element selector: ':file'
  */
 extern CSSSelector * fileSelector();
 
 /**
- @returns A header element selector: ':header'
+ @return A header element selector: ':header'
  */
 extern CSSSelector * headerSelector();
 
 /**
- @returns An image element selector: ':image'
+ @return An image element selector: ':image'
  */
 extern CSSSelector * imageSelector();
 
 /**
- @returns A parent element selector: ':parent'
+ @return A parent element selector: ':parent'
  */
 extern CSSSelector * inputSelector();
 
 /**
- @returns A link element selector: ':link'
+ @return A link element selector: ':link'
  */
 extern CSSSelector * linkSelector();
 
 /**
- @returns A password element selector: ':password'
+ @return A password element selector: ':password'
  */
 extern CSSSelector * passwordSelector();
 
 /**
- @returns A radio element selector: ':radio'
+ @return A radio element selector: ':radio'
  */
 extern CSSSelector * radioSelector();
 
 /**
- @returns A reset element selector: ':reset'
+ @return A reset element selector: ':reset'
  */
 extern CSSSelector * resetSelector();
 
 /**
- @returns A submit element selector: ':submit'
+ @return A submit element selector: ':submit'
  */
 extern CSSSelector * submitSelector();
 
 /**
- @returns A text element selector: ':text'
+ @return A text element selector: ':text'
  */
 extern CSSSelector * textSelector();
 
 /**
- @returns An enabled element selector: ':enabled'
+ @return An enabled element selector: ':enabled'
  */
 extern CSSSelector * enabledSelector();
 
 /**
- @returns A disabled element selector: ':disabled'
+ @return A disabled element selector: ':disabled'
  */
 extern CSSSelector * disabledSelector();
 
 /**
- @returns A checked element selector: ':checked'
+ @return A checked element selector: ':checked'
  */
 extern CSSSelector * checkedSelector();
 
 /**
- @returns An optional element selector: ':optional'
+ @return An optional element selector: ':optional'
  */
 extern CSSSelector * optionalSelector();
 
 /**
- @returns A required element selector: ':required'
+ @return A required element selector: ':required'
  */
 extern CSSSelector * requiredSelector();
 
@@ -116,7 +116,7 @@ extern CSSSelector * requiredSelector();
  Selects all elements at an index less than the specified index. A negative index counts backwards from the last element.
 
  @param index The zero-based index of the element to match.
- @returns A Less-Than selector.
+ @return A Less-Than selector.
  */
 extern CSSSelector * ltSelector(NSInteger index);
 
@@ -127,7 +127,7 @@ extern CSSSelector * ltSelector(NSInteger index);
  last element.
 
  @param index The zero-based index of the element to match.
- @returns A Greater-Than selector.
+ @return A Greater-Than selector.
  */
 extern CSSSelector * gtSelector(NSInteger index);
 
@@ -137,7 +137,7 @@ extern CSSSelector * gtSelector(NSInteger index);
  Selects the element at the specified index. A negative index counts backwards from the last element.
 
  @param index The zero-based index of the element to match.
- @returns An Equal selector.
+ @return An Equal selector.
  */
 extern CSSSelector * eqSelector(NSInteger index);
 

HTMLKit/CSSTypeSelector.h

@@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Returns the universal selector.
 
- @returns A new instance of a universal selector that matches all elements.
+ @return A new instance of a universal selector that matches all elements.
  */
 + (instancetype)universalSelector;
 
@@ -32,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new selector for the specified type.
 
  @param type The type of elements that should be matched.
- @returns A new instance of a type selector.
+ @return A new instance of a type selector.
  */
 - (instancetype)initWithType:(NSString *)type;
 

HTMLKit/HTMLCharacterToken.h

@@ -25,7 +25,7 @@
  Initializes a new character token.
  
  @param string The string with which to initialize the token.
- @returns A new instance of a character token.
+ @return A new instance of a character token.
  */
 - (instancetype)initWithString:(NSString *)string;
 
@@ -42,14 +42,14 @@
  @discussion HTML whitespace characters are: CHARACTER TABULATION U+0009, LINE FEED U+000A, FORM FEED U+000C,
  CARRIAGE RETURN U+000D, and SPACE U+0020
 
- @returns `YES` if this token contains only whitespace characters, `NO` otherwise.
+ @return `YES` if this token contains only whitespace characters, `NO` otherwise.
  */
 - (BOOL)isWhitespaceToken;
 
 /**
  Checks whether this token is empty.
 
- @returns `YES` if this token is empty, `NO` otherwise.
+ @return `YES` if this token is empty, `NO` otherwise.
  */
 - (BOOL)isEmpty;
 
@@ -74,7 +74,7 @@
  Splits this token retaining only characters after the leading whitespace. The leading whitespace characters are then
  returned a new characters token.
 
- @returns A characters token with leading whitespace characters. Returns 'nil` if no leading whitespace exists.
+ @return A characters token with leading whitespace characters. Returns 'nil` if no leading whitespace exists.
  */
 - (HTMLCharacterToken *)tokenBySplitingLeadingWhiteSpace;
 

HTMLKit/HTMLComment.h

@@ -22,7 +22,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new HTML comment node.
 
  @param data The comment string.
- @returns A new isntance of a HTML comment node.
+ @return A new isntance of a HTML comment node.
  */
 - (instancetype)initWithData:(NSString *)data;
 

HTMLKit/HTMLCommentToken.h

@@ -25,7 +25,7 @@
  Initializes a new comment token.
 
  @param string The string with which to initialize the token.
- @returns A new instance of a comment token.
+ @return A new instance of a comment token.
  */
 - (instancetype)initWithData:(NSString *)data;
 

HTMLKit/HTMLDOCTYPEToken.h

@@ -34,7 +34,7 @@
  Initializes a new DOCTYPE token.
 
  @param name The name with which to initialize the token.
- @returns A new instance of a DOCTYPE token.
+ @return A new instance of a DOCTYPE token.
  */
 - (instancetype)initWithName:(NSString *)name;
 

HTMLKit/HTMLDOMTokenList.h

@@ -33,12 +33,12 @@ NS_ASSUME_NONNULL_BEGIN
  @param element The associated context element.
  @param attribute The associated attribute.
  @param value The initial attribute's value.
- @returns A new instance of the DOM token list.
+ @return A new instance of the DOM token list.
  */
 - (instancetype)initWithElement:(HTMLElement *)element attribute:(NSString *)attribute value:(NSString *)value;
 
 /**
- @returns The length of this token list
+ @return The length of this token list
  */
 - (NSUInteger)length;
 
@@ -46,7 +46,7 @@ NS_ASSUME_NONNULL_BEGIN
  Checks whether this list contains the given token.
  
  @param token The token.
- @returns `YES` if the given token is in this list, `NO` otherwise.
+ @return `YES` if the given token is in this list, `NO` otherwise.
  */
 - (BOOL)contains:(NSString *)token;
 
@@ -68,7 +68,7 @@ NS_ASSUME_NONNULL_BEGIN
  Toggles the given token.
 
  @param token The token to toggle.
- @returns `YES` if the token was added to the list, `NO` if it was removed from it.
+ @return `YES` if the token was added to the list, `NO` if it was removed from it.
  */
 - (BOOL)toggle:(NSString *)token;
 
@@ -84,7 +84,7 @@ NS_ASSUME_NONNULL_BEGIN
  Returns the value of the token at the given index.
 
  @param index The index at which to return the token.
- @returns The token at the given index. If index is greater than or equal to the value returned by count, an
+ @return The token at the given index. If index is greater than or equal to the value returned by count, an
  NSRangeException is raised.
  */
 - (NSString *)objectAtIndexedSubscript:(NSUInteger)index;
@@ -99,7 +99,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)setObject:(NSString *)obj atIndexedSubscript:(NSUInteger)index;
 
 /**
- @returns The string representation of this token list, which can be used as the attribute's value.
+ @return The string representation of this token list, which can be used as the attribute's value.
  */
 - (NSString *)stringify;
 

HTMLKit/HTMLDocument.h

@@ -83,7 +83,7 @@ typedef NS_ENUM(short, HTMLDocumentReadyState)
  exception if node is an instance of HTMLDocument.
  
  @param node The node to adopt.
- @returns The adopted node
+ @return The adopted node
  */
 - (HTMLNode *)adoptNode:(HTMLNode *)node;
 

HTMLKit/HTMLDocumentFragment.h

@@ -22,7 +22,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new document fragment with the given document as owner.
  
  @param document The owner document.
- @returns A new instance of a document fragment.
+ @return A new instance of a document fragment.
  */
 - (instancetype)initWithDocument:(nullable HTMLDocument *)document;
 

HTMLKit/HTMLDocumentType.h

@@ -37,7 +37,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param name The name.
  @param publicIdentifier The public identifier.
  @param systemIdentifier The system identigier
- @returns A new document type instance.
+ @return A new document type instance.
  */
 - (instancetype)initWithName:(NSString *)name
 			publicIdentifier:(nullable NSString *)publicIdentifier
@@ -46,14 +46,14 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Checks whether this DOCTYPE is valid.
  
- @returns `YES` if this is a valid DOCTYPE, `NO` otherwise.
+ @return `YES` if this is a valid DOCTYPE, `NO` otherwise.
  */
 - (BOOL)isValid;
 
 /**
  Return the quirks mode of this DOCTYPE.
 
- @returns The quirks mode.
+ @return The quirks mode.
 
  @see HTMLQuirksMode
  */

HTMLKit/HTMLElement.h

@@ -64,7 +64,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new HTML element with the given tag name.
  
  @param tagname The tag name.
- @returns A new HTML element.
+ @return A new HTML element.
  */
 - (instancetype)initWithTagName:(NSString *)tagName;
 
@@ -73,7 +73,7 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param tagname The tag name.
  @param attributes The attributes.
- @returns A new HTML element.
+ @return A new HTML element.
  */
 - (instancetype)initWithTagName:(NSString *)tagName attributes:(NSDictionary *)attributes;
 
@@ -83,7 +83,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param tagname The tag name.
  @param namespace The namespace.
  @param attributes The attributes.
- @returns A new HTML element.
+ @return A new HTML element.
  */
 - (instancetype)initWithTagName:(NSString *)tagName namespace:(HTMLNamespace)htmlNamespace attributes:(NSDictionary *)attributes;
 
@@ -91,7 +91,7 @@ NS_ASSUME_NONNULL_BEGIN
  Checks whether this element has an attribute with the given name.
  
  @param name The attribute name.
- @returns `YES` if the element has such an attributes, `NO` otherwise.
+ @return `YES` if the element has such an attributes, `NO` otherwise.
  */
 - (BOOL)hasAttribute:(NSString *)name;
 
@@ -99,7 +99,7 @@ NS_ASSUME_NONNULL_BEGIN
  Returns the value of the attribute with the given name.
  
  @param name The attribute's name.
- @returns The attribute's value, `nil` if the element doesn't have such attribute.
+ @return The attribute's value, `nil` if the element doesn't have such attribute.
  */
 - (nullable NSString *)objectForKeyedSubscript:(NSString *)name;
 

HTMLKit/HTMLInputStreamReader.h

@@ -38,21 +38,21 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
  Initializes a new Input Stream Reader with the given string.
  
  @param string The HTML string
- @returns A new instance of the Input Stream Reader.
+ @return A new instance of the Input Stream Reader.
  */
 - (id)initWithString:(NSString *)string;
 
 /**
  Returns the current input character.
  
- @returns The current code point in the input stream as a `UTF32Char`.
+ @return The current code point in the input stream as a `UTF32Char`.
  */
 - (UTF32Char)currentInputCharacter;
 
 /**
  Returns the next input character without consuming it.
 
- @returns The next code point in the input stream as a `UTF32Char`. Returns `EOF` if the stream is fully consumed.
+ @return The next code point in the input stream as a `UTF32Char`. Returns `EOF` if the stream is fully consumed.
  */
 - (UTF32Char)nextInputCharacter;
 
@@ -60,7 +60,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
  Returns the input character at a given offset without consuming it.
 
  @param offset The offset of the character.
- @returns The code point in the input stream as a `UTF32Char` at the given offset.
+ @return The code point in the input stream as a `UTF32Char` at the given offset.
  */
 - (UTF32Char)inputCharacterPointAtOffset:(NSUInteger)offset;
 
@@ -68,7 +68,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
  Consumes and returns the next input character. Consuming a characters advances the current scan location of the
  input stream.
 
- @returns The next code point in the input stream as a `UTF32Char`. Returns `EOF` if the stream is fully consumed.
+ @return The next code point in the input stream as a `UTF32Char`. Returns `EOF` if the stream is fully consumed.
  */
 - (UTF32Char)consumeNextInputCharacter;
 
@@ -84,7 +84,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
  Consumes the given character at the current location.
  
  @param character The character to consume.
- @returns YES if the given character was consumed at the current location, NO otherwise.
+ @return YES if the given character was consumed at the current location, NO otherwise.
  */
 - (BOOL)consumeCharacter:(UTF32Char)character;
 
@@ -93,7 +93,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
 
  @param result Upon return, contains the consumed unsigned number. Pass `NULL` to skip over an unsigned number at the
  current location.
- @returns YES if an unsigned number could be consumed at the current location, NO otherwise.
+ @return YES if an unsigned number could be consumed at the current location, NO otherwise.
  */
 - (BOOL)consumeNumber:(unsigned long long *)result;
 
@@ -102,7 +102,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
 
  @param result Upon return, contains the consumed decimal number. Pass `NULL` to skip over a decimal number at the
  current location.
- @returns YES if a decimal number could be consumed at the current location, NO otherwise.
+ @return YES if a decimal number could be consumed at the current location, NO otherwise.
  */
 - (BOOL)consumeDecimalNumber:(NSDecimal *)result;
 
@@ -111,7 +111,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
 
  @param result Upon return, contains the consumed hexadecimal number. Pass `NULL` to skip over a hexadecimal number at 
  the current location.
- @returns YES if a hexadecimal number could be consumed at the current location, NO otherwise.
+ @return YES if a hexadecimal number could be consumed at the current location, NO otherwise.
  */
 - (BOOL)consumeHexNumber:(unsigned long long *)result;
 
@@ -120,7 +120,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
 
  @param string The string to consume.
  @param caseSensitive YES if the string's case should be ignored, NO otherwise
- @returns YES if the given string was consumed at the current location, NO otherwise.
+ @return YES if the given string was consumed at the current location, NO otherwise.
  */
 - (BOOL)consumeString:(NSString *)string caseSensitive:(BOOL)caseSensitive;
 
@@ -128,7 +128,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
  Consumes characters starting at the current location until any character in a given string is encountered.
 
  @param characters The string containing the characters to consume up to.
- @returns A string containing the consumed characters. Returns `nil` if none were consumed.
+ @return A string containing the consumed characters. Returns `nil` if none were consumed.
  */
 - (NSString *)consumeCharactersUpToCharactersInString:(NSString *)characters;
 
@@ -136,7 +136,7 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
  Consumes characters starting at the current location until a given string is encountered.
 
  @param string The string to consume up to.
- @returns A string containing the consumed characters. Returns `nil` if none were consumed.
+ @return A string containing the consumed characters. Returns `nil` if none were consumed.
  */
 - (NSString *)consumeCharactersUpToString:(NSString *)string;
 
@@ -144,14 +144,14 @@ typedef void (^ HTMLStreamReaderErrorCallback)(NSString *reason);
  Consumes characters as long as the match the characters in the given string starting at the current location.
 
  @param characters A string with the characters to consume.
- @returns A string containing the consumed characters. Returns `nil` if none were found.
+ @return A string containing the consumed characters. Returns `nil` if none were found.
  */
 - (NSString *)consumeCharactersInString:(NSString *)characters;
 
 /**
  Consumes alphanumeric characters starting at the current location.
 
- @returns A string containing the consumed alphanumeric characters. Returns `nil` if none were found.
+ @return A string containing the consumed alphanumeric characters. Returns `nil` if none were found.
  */
 - (NSString *)consumeAlphanumericCharacters;
 

HTMLKit/HTMLListOfActiveFormattingElements.h

@@ -40,7 +40,7 @@
  Returns the index of the given node in the list.
 
  @param node The node.
- @returns The index of the given node in the list.
+ @return The index of the given node in the list.
  */
 - (NSUInteger)indexOfElement:(id)node;
 
@@ -62,7 +62,7 @@
  Checks whether the given element is in the list.
 
  @param element The element to check.
- @returns `YES` if element is in the list, `NO` otherwise.
+ @return `YES` if element is in the list, `NO` otherwise.
  */
 - (BOOL)containsElement:(id)element;
 
@@ -85,7 +85,7 @@
 /**
  Returns the last element in this list.
  
- @returns The last entry.
+ @return The last entry.
  */
 - (id)lastEntry;
 
@@ -104,35 +104,35 @@
  in the list, if any, or the start of the list otherwise.
  
  @param tagName The tag name.
- @returns The formatting element.
+ @return The formatting element.
  */
 - (HTMLElement *)formattingElementWithTagName:(NSString *)tagName;
 
 /**
  Returns the count of elements in this list.
 
- @returns The elements count.
+ @return The elements count.
  */
 - (NSUInteger)count;
 
 /**
  Checks whether this list is empty.
 
- @returns `YES` if the stack is empty, `NO` otherwise.
+ @return `YES` if the stack is empty, `NO` otherwise.
  */
 - (BOOL)isEmpty;
 
 /**
  Return an object enumerator over this list.
 
- @returns An enumerator
+ @return An enumerator
  */
 - (NSEnumerator *)enumerator;
 
 /**
  Return an object enumerator over this list.
 
- @returns An enumerator
+ @return An enumerator
  */
 - (NSEnumerator *)reverseObjectEnumerator;
 

HTMLKit/HTMLNode+Private.h

@@ -35,7 +35,7 @@
  
  @param name The node's name.
  @param type The node's type.
- @returns A new instance of a HTML Node.
+ @return A new instance of a HTML Node.
  */
 - (instancetype)initWithName:(NSString *)name type:(HTMLNodeType)type NS_DESIGNATED_INITIALIZER;
 

HTMLKit/HTMLNode.h

@@ -145,7 +145,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
 /**
  Checks whether this node has child nodes.
  
- @returns `YES` if this node has any children, `NO` otherwise.
+ @return `YES` if this node has any children, `NO` otherwise.
  */
 - (BOOL)hasChildNodes;
 
@@ -153,14 +153,14 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Checks whether this node has child nodes of the given type.
 
  @param type The type to check.
- @returns `YES` if this node has any children of the given type, `NO` otherwise.
+ @return `YES` if this node has any children of the given type, `NO` otherwise.
  */
 - (BOOL)hasChildNodeOfType:(HTMLNodeType)type;
 
 /**
  Returns the cound of child nodes.
 
- @returns The child nodes count.
+ @return The child nodes count.
  */
 - (NSUInteger)childNodesCount;
 
@@ -168,7 +168,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns the child node at a given index.
 
  @param index The index at which to return the child node.
- @returns The child node at a index. If index is greater than or equal to the value returned by count, an 
+ @return The child node at a index. If index is greater than or equal to the value returned by count, an 
  NSRangeException is raised.
  */
 - (HTMLNode *)childNodeAtIndex:(NSUInteger)index;
@@ -177,7 +177,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns the index of the given child node in the set of child nodes.
 
  @param node The node.
- @returns The index of the given node in the children set.
+ @return The index of the given node in the children set.
  */
 - (NSUInteger)indexOfChildNode:(HTMLNode *)node;
 
@@ -186,7 +186,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
 
  @discussion This method count only nodes of type HTMLNodeElement.
 
- @returns The child elements count.
+ @return The child elements count.
  */
 - (NSUInteger)childElementsCount;
 
@@ -194,7 +194,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns the child element at a given index.
 
  @param index The index at which to return the child element.
- @returns The child element at a index. If index is greater than or equal to the value returned by count, an
+ @return The child element at a index. If index is greater than or equal to the value returned by count, an
  NSRangeException is raised.
  */
 - (HTMLElement *)childElementAtIndex:(NSUInteger)index;
@@ -203,7 +203,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns the index of the given child element in the set of child nodes.
 
  @param node The element.
- @returns The index of the given element in the children set.
+ @return The index of the given element in the children set.
  */
 - (NSUInteger)indexOfChildElement:(HTMLElement *)element;
 
@@ -211,7 +211,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Prepends the given node to the set of child nodes.
 
  @param node The node to prepend.
- @returns The node being prepended.
+ @return The node being prepended.
  */
 - (HTMLNode *)prependNode:(HTMLNode *)node;
 
@@ -226,7 +226,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Appends the given node to the set of child nodes.
 
  @param node The node to append.
- @returns The node being appended.
+ @return The node being appended.
  */
 - (HTMLNode *)appendNode:(HTMLNode *)node;
 
@@ -243,7 +243,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  @param node The node to insert.
  @param child A reference child node before which the new node should be inserted. If child is `nil` then the new node
  will be inserted as the last child node.
- @returns The node being inserted.
+ @return The node being inserted.
  */
 - (HTMLNode *)insertNode:(HTMLNode *)node beforeChildNode:(nullable HTMLNode *)child;
 
@@ -252,7 +252,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
 
  @param child The child node to replace.
  @param replacement The replacement node.
- @returns The replacement node.
+ @return The replacement node.
  */
 - (HTMLNode *)replaceChildNode:(HTMLNode *)child withNode:(HTMLNode *)replacement;
 
@@ -303,7 +303,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Compares the position of this node with the given node in the document.
 
  @param node The node with which to comapre the position.
- @returns The HTMLDocumentPosition of this node in relation to the given node.
+ @return The HTMLDocumentPosition of this node in relation to the given node.
 
  @see HTMLDocumentPosition
  */
@@ -313,7 +313,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Checks whether this node is descendant of the given node.
  
  @param node The node to check.
- @returns `YES` if this node is descendant of the gicen node, `NO` otherwsie.
+ @return `YES` if this node is descendant of the gicen node, `NO` otherwsie.
  */
 - (BOOL)isDescendantOfNode:(HTMLNode *)node;
 
@@ -321,7 +321,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Checks whether this node contains the given node.
 
  @param node The node to check.
- @returns `YES` if this node contains the given node, `NO` otherwsie.
+ @return `YES` if this node contains the given node, `NO` otherwsie.
  */
 - (BOOL)containsNode:(HTMLNode *)node;
 
@@ -344,7 +344,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
 /**
  Returns a node iterator rooted at this node whith no filter and HTMLNodeFilterShowAll.
 
- @returns A new node iterator whose root is this node.
+ @return A new node iterator whose root is this node.
 
  @see HTMLNodeIterator
  @see HTMLNodeFilterShowOptions
@@ -356,7 +356,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
 
  @param showOptions The iterator's show options.
  @param filter The iterator's filter.
- @returns A new node iterator whose root is this node.
+ @return A new node iterator whose root is this node.
 
  @see HTMLNodeIterator
  @see HTMLNodeFilterShowOptions
@@ -369,7 +369,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
 
  @param showOptions The iterator's show options.
  @param filter The iterator's filter block.
- @returns A new node iterator whose root is this node.
+ @return A new node iterator whose root is this node.
 
  @see HTMLNodeIterator
  @see HTMLNodeFilterShowOptions
@@ -381,7 +381,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns the first element in the DOM tree rooted at this node, that is matched by the given selector string.
  
  @param selector The CSS seletor string.
- @returns The first element that is matched by the parsed selector. Rerturns `nil` if the selector could not be parsed
+ @return The first element that is matched by the parsed selector. Rerturns `nil` if the selector could not be parsed
  or no element was matched.
 
  @see firstElementMatchingSelector:
@@ -393,7 +393,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns all elements in the DOM tree rooted at this node, that are matched by the given selector string.
 
  @param selector The CSS seletor string.
- @returns The elements that are matched by the parsed selector. Rerturns an empty array if the selector could not be parsed
+ @return The elements that are matched by the parsed selector. Rerturns an empty array if the selector could not be parsed
  or no elements were matched.
 
  @see elementsMatchingSelector:
@@ -405,7 +405,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns the first element in the DOM tree rooted at this node, that is matched by the given selector.
 
  @param selector The CSS seletor.
- @returns The first element that is matched by the parsed selector. Rerturns `nil` if no element was matched.
+ @return The first element that is matched by the parsed selector. Rerturns `nil` if no element was matched.
 
  @see CSSSelector
  */
@@ -415,7 +415,7 @@ typedef NS_ENUM(unsigned short, HTMLDocumentPosition)
  Returns all elements in the DOM tree rooted at this node, that are matched by the given selector.
 
  @param selector The CSS seletor.
- @returns The elements that are matched by the parsed selector. Rerturns an empty array if no elements were matched.
+ @return The elements that are matched by the parsed selector. Rerturns an empty array if no elements were matched.
 
  @see CSSSelector
  */

HTMLKit/HTMLNodeFilter.h

@@ -55,7 +55,7 @@ typedef NS_OPTIONS(unsigned long, HTMLNodeFilterShowOptions)
  The implementation should return a HTMLNodeFilterValue to indicate accepting, skipping or rejecting a node.
  
  @param node The node to be filtered.
- @returns `HTMLNodeFilterAccept` if accepted, `HTMLNodeFilterSkip` if skipped, or `HTMLNodeFilterReject` if rejected.
+ @return `HTMLNodeFilterAccept` if accepted, `HTMLNodeFilterSkip` if skipped, or `HTMLNodeFilterReject` if rejected.
  */
 - (HTMLNodeFilterValue)acceptNode:(HTMLNode *)node;
 

HTMLKit/HTMLNodeIterator.h

@@ -54,7 +54,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new node iterator with no filter and HTMLNodeFilterShowAll show options.
 
  @param node The root node.
- @returns A new instance of a node iterator.
+ @return A new instance of a node iterator.
  */
 - (instancetype)initWithNode:(HTMLNode *)node;
 
@@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param node The root node.
  @param filter The node filter to use.
- @returns A new instance of a node iterator.
+ @return A new instance of a node iterator.
  */
 - (instancetype)initWithNode:(HTMLNode *)node
 					  filter:(nullable id<HTMLNodeFilter>)filter;
@@ -74,19 +74,19 @@ NS_ASSUME_NONNULL_BEGIN
  @param node The root node.
  @param showOptions The show options for the iterator.
  @param filter The node filter to use.
- @returns A new instance of a node iterator.
+ @return A new instance of a node iterator.
  */
 - (instancetype)initWithNode:(HTMLNode *)node
 				 showOptions:(HTMLNodeFilterShowOptions)showOptions
 					  filter:(nullable id<HTMLNodeFilter>)filter;
 
 /**
- @returns The next iterated node in tree order, `nil` if there are no more nodes to iterate.
+ @return The next iterated node in tree order, `nil` if there are no more nodes to iterate.
  */
 - (nullable HTMLNode *)nextNode;
 
 /**
- @returns The previous iterated node in tree order, `nil` if there are no more nodes to iterate.
+ @return The previous iterated node in tree order, `nil` if there are no more nodes to iterate.
  */
 - (nullable HTMLNode *)previousNode;
 

HTMLKit/HTMLOrderedDictionary.h

@@ -19,7 +19,7 @@ NS_ASSUME_NONNULL_BEGIN
  Returns the object at the specified index.
 
  @param index An index within the bounds of the dictionary.
- @returns The object located at index.
+ @return The object located at index.
  */
 - (ObjectType)objectAtIndex:(NSUInteger)index;
 
@@ -60,7 +60,7 @@ NS_ASSUME_NONNULL_BEGIN
  Returns the index of the given key in the dictionary.
 
  @param aKey The key.
- @returns The index of the given key in the dictionary.
+ @return The index of the given key in the dictionary.
  */
 - (NSUInteger)indexOfKey:(KeyType<NSCopying>)aKey;
 
@@ -81,7 +81,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)setObject:(ObjectType)obj atIndexedSubscript:(NSUInteger)index;
 
 /**
- @returns A reverse key enumerator.
+ @return A reverse key enumerator.
  */
 - (NSEnumerator<KeyType> *)reverseKeyEnumerator;
 

HTMLKit/HTMLParseErrorToken.h

@@ -29,7 +29,7 @@
 
  @param reason The error's reason message.
  @param location The error's location in the stream.
- @returns A new instance of a parse error token.
+ @return A new instance of a parse error token.
  */
 - (instancetype)initWithReasonMessage:(NSString *)reason andStreamLocation:(NSUInteger)location;
 

HTMLKit/HTMLParser.h

@@ -41,14 +41,14 @@ NS_ASSUME_NONNULL_BEGIN
  https://html.spec.whatwg.org/multipage/syntax.html#determining-the-character-encoding
 
  @param string The HTML string to parse
- @returns A new instance of the HTML parser.
+ @return A new instance of the HTML parser.
  */
 - (instancetype)initWithString:(NSString *)string;
 
 /**
  Runs the parsing algorithm and generates a valid HTML document object.
 
- @returns A HTML document object that is the result of parsing the HTML string, with which this parser instance was
+ @return A HTML document object that is the result of parsing the HTML string, with which this parser instance was
  initialized
  
  @see HTMLDocument
@@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN
  instance. In this case the parser will reset its internal state and re-run the parsing algorithm.
 
  @param contextElement A context element used for parsing a HTML fragment
- @returns An array of HTML elements, that are the result of parsing the given HTML string with the given context element.
+ @return An array of HTML elements, that are the result of parsing the given HTML string with the given context element.
 
  @see HTMLElement
  */

HTMLKit/HTMLStackOfOpenElements.h

@@ -50,7 +50,7 @@
  Returns the index of the given node in the stack.
  
  @param node The node.
- @returns The index of the given node in the stack.
+ @return The index of the given node in the stack.
  */
 - (NSUInteger)indexOfElement:(id)node;
 
@@ -72,7 +72,7 @@
  Checks whether the given element is in the stack.
 
  @param element The element.
- @returns `YES` if the element is in the stack, `NO` otherwise.
+ @return `YES` if the element is in the stack, `NO` otherwise.
  */
 - (BOOL)containsElement:(id)element;
 
@@ -80,7 +80,7 @@
  Checks whether an element with the given tag name is in the stack.
 
  @param tagname The element's tag name.
- @returns `YES` if such an element is in the stack, `NO` otherwise.
+ @return `YES` if such an element is in the stack, `NO` otherwise.
  */
 - (BOOL)containsElementWithTagName:(NSString *)tagName;
 
@@ -178,35 +178,35 @@
  https://html.spec.whatwg.org/multipage/syntax.html#adoption-agency-algorithm
 
  @param index The index.
- @returns The furthest block after index.
+ @return The furthest block after index.
  */
 - (HTMLElement *)furthestBlockAfterIndex:(NSUInteger)index;
 
 /**
  Returns the count of elements in this stack.
  
- @returns The elements count.
+ @return The elements count.
  */
 - (NSUInteger)count;
 
 /**
  Checks whether this stack is empty.
  
- @returns `YES` if the stack is empty, `NO` otherwise.
+ @return `YES` if the stack is empty, `NO` otherwise.
  */
 - (BOOL)isEmpy;
 
 /**
  Return an object enumerator over this stack.
  
- @returns An enumerator
+ @return An enumerator
  */
 - (NSEnumerator *)enumerator;
 
 /**
  Return a reverse object enumerator over this stack.
 
- @returns A reverse enumerator
+ @return A reverse enumerator
  */
 - (NSEnumerator *)reverseObjectEnumerator;
 

HTMLKit/HTMLTagToken.h

@@ -32,7 +32,7 @@
  Initializes a new tag token.
 
  @param tagName The tag's name.
- @returns A new instance of a tag token.
+ @return A new instance of a tag token.
  */
 - (instancetype)initWithTagName:(NSString *)tagName;
 
@@ -41,7 +41,7 @@
 
  @param tagName The tag's name.
  @param attributes The tag's attributes.
- @returns A new instance of a tag token.
+ @return A new instance of a tag token.
  */
 - (instancetype)initWithTagName:(NSString *)tagName attributes:(NSMutableDictionary *)attributes;
 

HTMLKit/HTMLText.h

@@ -22,7 +22,7 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new HTML text node.
 
  @param data The text string.
- @returns A new isntance of a HTML text node.
+ @return A new isntance of a HTML text node.
  */
 - (instancetype)initWithData:(NSString *)data;
 

HTMLKit/HTMLTokenizer.h

@@ -43,7 +43,7 @@
  Initializes a new Tokenizer with the given string.
 
  @param string The HTML string
- @returns A new instance of the Tokenizer.
+ @return A new instance of the Tokenizer.
  */
 - (instancetype)initWithString:(NSString *)string;
 

HTMLKit/HTMLTokenizerEntities.h

@@ -25,7 +25,7 @@
  Returns the replacement entity at the given index.
 
  @param index The index of the character reference.
- @returns The replacement character reference entitiy.
+ @return The replacement character reference entitiy.
  */
 + (NSString *)replacementAtIndex:(NSUInteger)index;
 

HTMLKit/HTMLTreeWalker.h

@@ -50,7 +50,7 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param node The root node.
  @param filter The node filter to use.
- @returns A new instance of a tree walker.
+ @return A new instance of a tree walker.
  */
 - (instancetype)initWithNode:(HTMLNode *)node;
 
@@ -59,7 +59,7 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param node The root node.
  @param filter The node filter to use.
- @returns A new instance of a tree walker.
+ @return A new instance of a tree walker.
  */
 - (instancetype)initWithNode:(HTMLNode *)node
 					  filter:(nullable id<HTMLNodeFilter>)filter;
@@ -70,7 +70,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param node The root node.
  @param showOptions The show options for the walker.
  @param filter The node filter to use.
- @returns A new instance of a tree walker.
+ @return A new instance of a tree walker.
  */
 - (instancetype)initWithNode:(HTMLNode *)node
 				 showOptions:(HTMLNodeFilterShowOptions)showOptions

HTMLKit/NSString+HTMLKit.h

@@ -18,33 +18,33 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Checks whether this string is equal to another ignoring the case.
 
- @returns `YES` if the two string are equal ignroing the case, `NO` otherwise.
+ @return `YES` if the two string are equal ignroing the case, `NO` otherwise.
  */
 - (BOOL)isEqualToStringIgnoringCase:(NSString *)aString;
 
 /**
  Checks whether this string is equal to any of the given strings.
 
- @returns `YES` if there is an equal string, `NO` otherwise.
+ @return `YES` if there is an equal string, `NO` otherwise.
  */
 - (BOOL)isEqualToAny:(NSString *)first, ... NS_REQUIRES_NIL_TERMINATION;
 
 /**
  Checks whether this string has a prefix ignoring the case.
 
- @returns `YES` if this string has a given prefix ignroing the case, `NO` otherwise.
+ @return `YES` if this string has a given prefix ignroing the case, `NO` otherwise.
  */
 - (BOOL)hasPrefixIgnoringCase:(NSString *)aString;
 
 /**
  Checks whether this string is a HTML whitespace string.
 
- @returns `YES` if this string is a HTML whitespace string, `NO` otherwise.
+ @return `YES` if this string is a HTML whitespace string, `NO` otherwise.
  */
 - (BOOL)isHTMLWhitespaceString;
 
 /**
- @returns The length of the leading HTML whitespace characters in this string.
+ @return The length of the leading HTML whitespace characters in this string.
  */
 - (NSUInteger)leadingHTMLWhitespaceLength;