diff options
author | Zach Copley <zach@status.net> | 2010-03-30 18:52:21 -0700 |
---|---|---|
committer | Zach Copley <zach@status.net> | 2010-04-22 13:11:49 -0700 |
commit | 1b561065b0ff8d7082d8da49750a4bc99a4830e2 (patch) | |
tree | 45906a7f7c6639351a4b312e1f6b496ac7ef9406 /lib/apiauth.php | |
parent | 65796ba03ba4cd0470a1e9790d2234c8b42d6cba (diff) |
Some initial Doxygen-based documentation for the API
Diffstat (limited to 'lib/apiauth.php')
-rw-r--r-- | lib/apiauth.php | 18 |
1 files changed, 18 insertions, 0 deletions
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); } |