summaryrefslogtreecommitdiff
path: root/lib/apiaction.php
diff options
context:
space:
mode:
authorZach Copley <zach@status.net>2010-03-30 18:52:21 -0700
committerZach Copley <zach@status.net>2010-04-22 13:11:49 -0700
commit1b561065b0ff8d7082d8da49750a4bc99a4830e2 (patch)
tree45906a7f7c6639351a4b312e1f6b496ac7ef9406 /lib/apiaction.php
parent65796ba03ba4cd0470a1e9790d2234c8b42d6cba (diff)
Some initial Doxygen-based documentation for the API
Diffstat (limited to 'lib/apiaction.php')
-rw-r--r--lib/apiaction.php60
1 files changed, 60 insertions, 0 deletions
diff --git a/lib/apiaction.php b/lib/apiaction.php
index d5580abd3..f206f1d5c 100644
--- a/lib/apiaction.php
+++ b/lib/apiaction.php
@@ -32,6 +32,66 @@
* @link http://status.net/
*/
+/* External API usage documentation. Please update when you change how the API works. */
+
+/*! @mainpage StatusNet REST API
+
+ @section Introduction
+
+ Some explanatory text about the API would be nice.
+
+ @section API Methods
+
+ @subsection timelinesmethods_sec Timeline Methods
+
+ @li @ref friendstimeline
+
+ @subsection statusmethods_sec Status Methods
+
+ @li @ref statusesupdate
+
+ @subsection usermethods_sec User Methods
+
+ @subsection directmessagemethods_sec Direct Message Methods
+
+ @subsection friendshipmethods_sec Friendship Methods
+
+ @subsection socialgraphmethods_sec Social Graph Methods
+
+ @subsection accountmethods_sec Account Methods
+
+ @subsection favoritesmethods_sec Favorites Methods
+
+ @subsection blockmethods_sec Block Methods
+
+ @subsection oauthmethods_sec OAuth Methods
+
+ @subsection helpmethods_sec Help Methods
+
+ @subsection groupmethods_sec Group Methods
+
+ @page apiroot API Root
+
+ The URLs for methods referred to in this API documentation are
+ relative to the StatusNet API root. The API root is determined by the
+ site's @b server and @b path variables, which are generally specified
+ in config.php. For example:
+
+ @code
+ $config['site']['server'] = 'example.org';
+ $config['site']['path'] = 'statusnet'
+ @endcode
+
+ The pattern for a site's API root is: @c protocol://server/path/api E.g:
+
+ @c http://example.org/statusnet/api
+
+ The @b path can be empty. In that case the API root would simply be:
+
+ @c http://example.org/api
+
+*/
+
if (!defined('STATUSNET')) {
exit(1);
}