Documentation updates

Author: bummytime

Classes/HRColorPickerViewController.h

@@ -66,8 +66,10 @@ typedef enum {
  */
 - (id)initWithColor:(UIColor*)defaultColor fullColor:(BOOL)fullColor saveStyle:(HCPCSaveStyle)saveStyle;
 
-/** @deprecated use -save: instead of this . */
-- (void)saveColor:(id)sender;
+/**
+ * @deprecated use -save: instead of this.
+ */
+- (void)saveColor:(id)sender __attribute__((deprecated));
 
 - (void)save;
 - (void)save:(id)sender;

Classes/WPEditorField.h

@@ -18,7 +18,7 @@
  *  @brief      Initializes the field with the specified HTML node id.
  *
  *  @param      nodeId      The id of the html node this object will wrap.  Cannot be nil.
- *  @param      webVieq     The web view to use for all javascript calls.  Cannot be nil.
+ *  @param      webView     The web view to use for all javascript calls.  Cannot be nil.
  *
  *  @returns    The initialized object.
  */
@@ -87,7 +87,7 @@
 /**
  *  @brief      Sets the placeholder color for this field.
  *
- *  @param      placeholderText     The new placeholder color.
+ *  @param      placeholderColor     The new placeholder color.
  */
 - (void)setPlaceholderColor:(UIColor *)placeholderColor;
 

Classes/WPEditorView.h

@@ -124,7 +124,7 @@
  * @brief		Received when the user taps on a video in the editor.
  *
  * @param		editorView	The editor view.
- * @param		videoId		The id of image of the image that was tapped.
+ * @param		videoID		The id of image of the image that was tapped.
  * @param		url			The url of the image that was tapped.
  *
  */
@@ -156,7 +156,7 @@ stylesForCurrentSelection:(NSArray*)styles;
  * @brief		Received when a video local url is replaced by the final remote url.
  *
  * @param		editorView	The editor view.
- * @param		videoId		The unique id of the video that had the local url replaced by remote url.
+ * @param		videoID		The unique id of the video that had the local url replaced by remote url.
  *
  */
 - (void)editorView:(WPEditorView*)editorView
@@ -166,7 +166,7 @@ stylesForCurrentSelection:(NSArray*)styles;
  * @brief		Received when an image is pasted into the editor.
  *
  * @param       editorView  The editor view.
- * @param       imageId     The id of image of the image that was pasted.
+ * @param       image The image that was pasted.
  *
  */
 - (void)editorView:(WPEditorView*)editorView

Classes/WPEditorView.m

@@ -680,7 +680,7 @@ - (void)handleVideoTappedCallback:(NSURL *)url
 /**
  *	@brief		Handles a video entered fullscreen callback
  *
- *	@param		url		The url with all the callback information.
+ *	@param		aURL		The url with all the callback information.
  */
 - (void)handleVideoFullScreenStartedCallback:(NSURL *)aURL
 {
@@ -717,7 +717,7 @@ - (UIView *)findFirstResponder:(UIView *)currentView
 /**
  *	@brief		Handles a video ended fullscreen callback.
  *
- *	@param		url		The url with all the callback information.
+ *	@param		aURL		The url with all the callback information.
  */
 - (void)handleVideoFullScreenEndedCallback:(NSURL *)aURL
 {

Classes/WPEditorViewController.h

@@ -31,7 +31,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the format bar enabled status has changed.
  *	@param		editorController    The editor view.
- *	@param		enabled             BOOL describing the new state of the format bar
+ *	@param		isEnabled             BOOL describing the new state of the format bar
  */
 - (void)editorFormatBarStatusChanged:(WPEditorViewController *)editorController
                              enabled:(BOOL)isEnabled;
@@ -41,7 +41,7 @@ WPEditorViewControllerMode;
  *  @details    The editor fields will be nil before this method is called.  This is because editor
  *              fields are created as part of the process of loading the HTML.
  *
- *	@param		editorView		The editor view.
+ *	@param		editorViewController		The editor view controller.
  *	@param		field			The new field.
  */
 - (void)editorViewController:(WPEditorViewController*)editorViewController
@@ -50,7 +50,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the user taps on a image in the editor.
  *
- *	@param		editorView	The editor view.
+ *	@param		editorViewController	The editor view controller.
  *	@param		imageId		The id of image of the image that was tapped.
  *	@param		url			The url of the image that was tapped.
  *
@@ -62,7 +62,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the user taps on a image in the editor.
  *
- *	@param		editorView	The editor view.
+ *	@param		editorViewController	The editor view controller.
  *	@param		imageId		The id of image of the image that was tapped.
  *	@param		url			The url of the image that was tapped.
  *  @param		imageMeta	The parsed meta data about the image.
@@ -75,7 +75,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the user taps on a image in the editor.
  *
- *	@param		editorView	The editor view.
+ *	@param		editorViewController	The editor view controller.
  *	@param		videoID		The id of the video that was tapped.
  *	@param		url			The url of the video that was tapped.
  *
@@ -87,7 +87,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the local image url is replace by the final image in the editor.
  *
- *	@param		editorView	The editor view.
+ *	@param		editorViewController	The editor view controller.
  *	@param		imageId		The id of image of the image that was tapped.
  */
 - (void)editorViewController:(WPEditorViewController*)editorViewController
@@ -96,7 +96,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the local video url is replace by the final video in the editor.
  *
- *	@param		editorView	The editor view.
+ *	@param		editorViewController	The editor view controller.
  *	@param		videoID		The id of video that was tapped.
  */
 - (void)editorViewController:(WPEditorViewController*)editorViewController
@@ -106,7 +106,7 @@ WPEditorViewControllerMode;
  * @brief		Received when an image is pasted into the editor.
  *
  * @param		editorViewController    The editor view controller.
- * @param		imageId                 The id of image of the image that was pasted.
+ * @param		image                   The image that was pasted.
  *
  */
 - (void)editorViewController:(WPEditorViewController*)editorViewController
@@ -115,7 +115,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the editor requests information about a videopress video.
  *
- *	@param		editorView	The editor view.
+ *	@param		editorViewController    The editor view controller.
  *	@param		videoID		The id of video that was tapped.
  */
 - (void)editorViewController:(WPEditorViewController *)editorViewController
@@ -124,7 +124,7 @@ WPEditorViewControllerMode;
 /**
  *	@brief		Received when the editor removed an uploading media.
  *
- *	@param		editorView	The editor view.
+ *	@param		editorViewController    The editor view controller.
  *	@param		mediaID		The id of the media that was removed.
  */
 - (void)editorViewController:(WPEditorViewController *)editorViewController

Classes/WPEditorViewController.m

@@ -866,8 +866,6 @@ - (void)updateImage:(NSString *)url alt:(NSString *)alt
 
 /**
  *	@brief		Returns an URL from the general pasteboard.
- *
- *	@param		The URL or nil if no valid URL is found.
  */
 - (NSURL*)urlFromPasteboard
 {