more docs

2015-07-15 21:33:06 +00:00
parent 28a943f4eb
commit 0d2eeb25e0
10 changed files with 252 additions and 10 deletions
--- a/html/get.php
+++ b/html/get.php
@@ -1,4 +1,33 @@
 <?php
+/*! @file
+
+    @id $Id$
+
+    @see @ref apiget
+
+    @page api
+
+    @section apiget Get Messages
+
+    API-call get.php
+
+    Get all messages that are newer than start.
+
+    @param start Number of message to start with.
+    @return json encoded array of messages:
+       @code
+           [
+             {
+               id: message-id,
+               time: unix-time-stamp,
+               user: 'sender's user name',
+               msg: 'armored and encrypted message as string'
+             }, ...
+           ]
+       @endcode
+*/
+//       1         2         3         4         5         6         7         8
+// 45678901234567890123456789012345678901234567890123456789012345678901234567890
 require_once("messagetable.php");
 try {
  $start = $db->real_escape_string($_REQUEST['start']);