Added a missing @result to WKPreferences headerdoc
authorggaren@apple.com <ggaren@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 29 May 2014 18:38:06 +0000 (18:38 +0000)
committerggaren@apple.com <ggaren@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 29 May 2014 18:38:06 +0000 (18:38 +0000)
https://bugs.webkit.org/show_bug.cgi?id=133381

Reviewed by Dan Bernstein.

* UIProcess/API/Cocoa/WKPreferences.h:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@169458 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebKit2/ChangeLog
Source/WebKit2/UIProcess/API/Cocoa/WKPreferences.h

index 4bc0458..ebe4ddf 100644 (file)
@@ -1,3 +1,12 @@
+2014-05-29  Geoffrey Garen  <ggaren@apple.com>
+
+        Added a missing @result to WKPreferences headerdoc
+        https://bugs.webkit.org/show_bug.cgi?id=133381
+
+        Reviewed by Dan Bernstein.
+
+        * UIProcess/API/Cocoa/WKPreferences.h:
+
 2014-05-29  Alexey Proskuryakov  <ap@apple.com>
 
         [Mac] Always use plug-in sandbox with sandboxed clients
index 62a86e6..03796e3 100644 (file)
@@ -38,6 +38,7 @@ WK_CLASS_AVAILABLE(10_10, 8_0)
 
 /*! @abstract Returns an initialized WKPreferences object.
  @param userDefaultsKeyPrefix The user defaults key prefix.
+ @result An initialized WKPreferences object, or nil if the object could not be initialized.
  @discussion If the userDefaultsKeyPrefix argument is non-nil, it is prepended to the keys used to store preferences
  in the user defaults database. If the argument is nil, the preferences object won't save anything to the user defaults database.
  */