better documentation

This commit is contained in:
Marc Wäckerlin
2015-11-09 15:12:51 +00:00
parent 4f8d997805
commit 3e3c3b276e
7 changed files with 89 additions and 51 deletions

View File

@@ -6,18 +6,17 @@
#EXTRA_DIST = ${www_DATA}
wwwdir = ${pkgdatadir}/html
dist_www_DATA = index.html chat.html newuser.html safechat.js \
jquery.js openpgp.js jquery.cssemoticons.js \
safechat.css jquery.cssemoticons.css checknewuser.php \
get.php login.php messagetable.php pubkey.php \
send.php usertable.php abort.svg \
A-Tone-His_Self-1266414414.mp3 attachment.svg \
audio.svg chat-rodrigo-angleton.svg \
Checkout-Scanner-Beep-SoundBible.com-593325210-by-Mike-Koenig.mp3 \
envelope.svg functions.php menu.svg pfeil.svg \
photo.png photo.svg safechat-rodrigo-angleton.svg \
safe-mimooh.svg send.svg update-messages.js video.png \
video.svg messagetable.sql usertable.sql
dist_www_DATA = index.html chat.html newuser.html safechat.js \
jquery.js openpgp.js jquery.cssemoticons.js \
safechat.css jquery.cssemoticons.css checknewuser.php \
get.php login.php pubkey.php send.php abort.svg \
A-Tone-His_Self-1266414414.mp3 attachment.svg \
audio.svg chat-rodrigo-angleton.svg \
Checkout-Scanner-Beep-SoundBible.com-593325210-by-Mike-Koenig.mp3 \
envelope.svg functions.php menu.svg pfeil.svg \
photo.png photo.svg safechat-rodrigo-angleton.svg \
safe-mimooh.svg send.svg update-messages.js video.png \
video.svg opendb.php schema.sql
EXTRA_DIST = documentation.dox

View File

@@ -3,20 +3,7 @@
@id $Id$
@see @ref usertable for the database schema
@page database Database
@tableofcontents
@section usertable User Table
<table>
<caption>Table: user</caption>
<tr><th>Colum Name</th><th>SQL Type</th><th>Description</th></tr>
<tr><td>name</td><td>varchar(50)</td><td>The user's name (pseudonym).</td></tr>
<tr><td>pubkey</td><td>text</td><td>The user's public key.</td></tr>
</table>
@see @ref database for the database schema
*/
// 1 2 3 4 5 6 7 8