Fix ticket #2860: clarify API doc comments for 'source' parameter's interaction with...

diff --git a/actions/apistatusesupdate.php b/actions/apistatusesupdate.php
index 666ed9fa32330f55863073418530cd3206e1c752..1a3b549004750452200c45e5b658b16c5241370b 100644 (file)
--- a/actions/apistatusesupdate.php
+++ b/actions/apistatusesupdate.php
@@ -55,7 +55,7 @@
     Yes
 
     @param status (Required) The URL-encoded text of the status update.
-    @param source (Optional) The source of the status.
+    @param source (Optional) The source application name, if using HTTP authentication or an anonymous OAuth consumer.
     @param in_reply_to_status_id (Optional) The ID of an existing status that the update is in reply to.
     @param lat (Optional) The latitude the status refers to.
     @param long (Optional) The longitude the status refers to.
@@ -67,7 +67,7 @@
     @subsection usagenotes Usage notes
 
     @li The URL pattern is relative to the @ref apiroot.
-    @li If the @e source parameter is not supplied the source of the status will default to 'api'.
+    @li If the @e source parameter is not supplied the source of the status will default to 'api'. When authenticated via a registered OAuth application, the application's registered name and URL will always override the source parameter.
     @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
     to encode the latitude and longitude (see example response below <georss:point>).
     @li Data uploaded via the @e media parameter should be multipart/form-data encoded.