fixed documentation

ibru · Jun 21, 2012 · 41ede70 · 41ede70
1 parent d44e5c4
commit 41ede70
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/Core/Source/NSAttributedString+DTCoreText.h b/Core/Source/NSAttributedString+DTCoreText.h
@@ -58,7 +58,7 @@
 /**
  Returns the range of the given text block that contains the given location.
  
- @param list The text block.
+ @param textBlock The text block.
  @param location The location in the text.
  @returns The range of the given text block containing the location.
  */
@@ -67,7 +67,6 @@
 /**
  Returns the range of the given href anchor.
  
- @param list The text block.
  @param anchorName The name of the anchor.
  @returns The range of the given anchor.
  */
@@ -85,7 +84,7 @@
 - (NSString *)htmlString;
 
 
-/*
+/**
  Converts the receiver into plain text.
  
  This is different from the `string` method of `NSAttributedString` by also erasing placeholders for text attachments.

diff --git a/Core/Source/NSAttributedString+HTML.h b/Core/Source/NSAttributedString+HTML.h
@@ -22,7 +22,7 @@
  Initializes and returns a new `NSAttributedString` object from the HTML contained in the given object and base URL.
  @param data The data in HTML format from which to create the attributed string.
  @param docAttributes Currently not in used.
- @returns Returns an initialized object, or nil if the data can’t be decoded.
+ @returns Returns an initialized object, or `nil` if the data can’t be decoded.
  */
 - (id)initWithHTMLData:(NSData *)data documentAttributes:(NSDictionary **)docAttributes;
 
@@ -31,16 +31,16 @@
  @param data The data in HTML format from which to create the attributed string.
  @param baseURL An `NSURL` that represents the base URL for all links within the HTML.
  @param docAttributes Currently not in used.
- @returns Returns an initialized object, or nil if the data can’t be decoded.
+ @returns Returns an initialized object, or `nil` if the data can’t be decoded.
  */
 - (id)initWithHTMLData:(NSData *)data baseURL:(NSURL *)baseURL documentAttributes:(NSDictionary **)docAttributes;
 
 /**
  Initializes and returns a new `NSAttributedString` object from the HTML contained in the given object and base URL.
  @param data The data in HTML format from which to create the attributed string.
- @param baseURL An `NSURL` that represents the base URL for all links within the HTML.
+ @param options Specifies how the document should be loaded. Contains values described in “Option keys for importing documents.” 
  @param docAttributes Currently not in used.
- @returns Returns an initialized object, or nil if the data can’t be decoded.
+ @returns Returns an initialized object, or `nil` if the data can’t be decoded.
  */
 - (id)initWithHTMLData:(NSData *)data options:(NSDictionary *)options documentAttributes:(NSDictionary **)docAttributes;