aboutsummaryrefslogtreecommitdiff
path: root/index.php
diff options
context:
space:
mode:
authorSilvio <silvio@devlet.com.br>2011-02-22 10:37:10 -0300
committerSilvio Rhatto <silvio@devlet.com.br>2011-02-22 10:37:10 -0300
commitf253764c93f49dcdfe01b9e3f4d2a1352406b8f1 (patch)
treeb6a4d1d70cdb9cdfca0ec5984a458be1431313f7 /index.php
parent8b55b69339146f0b03b01dd1c12501754cbd9de0 (diff)
downloadcinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.gz
cinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.bz2
Documentation update
Diffstat (limited to 'index.php')
-rw-r--r--index.php11
1 files changed, 9 insertions, 2 deletions
diff --git a/index.php b/index.php
index 357d918..59ecaf9 100644
--- a/index.php
+++ b/index.php
@@ -1,6 +1,13 @@
<?php
-/**
- * Cinisis - Isis db reading tool.
+/*! \mainpage Cinisis Database Reader
+ *
+ * Cinisis is a <a href="https://secure.wikimedia.org/wikipedia/en/wiki/CDS/ISIS">CDS/ISIS</a>
+ * database reading library written in PHP. It's intended for integrating or migrating
+ * existing ISIS databases into other applications.
+ *
+ * Usage:
+ *
+ * \verbinclude README.txt
*/
// Autoloader.