From 1b561065b0ff8d7082d8da49750a4bc99a4830e2 Mon Sep 17 00:00:00 2001 From: Zach Copley Date: Tue, 30 Mar 2010 18:52:21 -0700 Subject: Some initial Doxygen-based documentation for the API --- lib/apiauth.php | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'lib/apiauth.php') diff --git a/lib/apiauth.php b/lib/apiauth.php index d6ad7e021..8c3998888 100644 --- a/lib/apiauth.php +++ b/lib/apiauth.php @@ -34,6 +34,24 @@ * @link http://status.net/ */ +/* External API usage documentation. Please update when you change how this method works. */ + +/*! @page authentication Authentication + + StatusNet supports HTTP Basic Authentication and OAuth for API calls. + + @warning Currently, users who have created accounts without setting a + password via OpenID, Facebook Connect, etc., cannot use the API until + they set a password with their account settings panel. + + @section HTTP Basic Auth + + + + @section OAuth + +*/ + if (!defined('STATUSNET')) { exit(1); } -- cgit v1.2.3-54-g00ecf