issue #383: updated documentation

Documentation/Makefile.files

@@ -81,6 +81,8 @@ WIKI = \
 	IndexBitArray \
 	IndexCap \
 	IndexCapHttp \
+	IndexFulltext \
+	IndexFulltextHttp \
 	IndexGeo \
 	IndexGeoHttp \
 	IndexHash \

Documentation/Manual/Glossary.md

@@ -23,14 +23,18 @@ Glossary {#Glossary}
 
 @copydoc GlossaryEdgeCollection
 
-@copydoc GlossaryIndexGeo
-
-@copydoc GlossaryIndexHash
-
 @copydoc GlossaryIndex
 
 @copydoc GlossaryIndexHandle
 
+@copydoc GlossaryIndexEdge
+
+@copydoc GlossaryIndexFulltext
+
+@copydoc GlossaryIndexGeo
+
+@copydoc GlossaryIndexHash
+
 @copydoc GlossaryIndexPrioQueue
 
 @copydoc GlossaryIndexSkiplist

arangod/Documentation/api-simple.dox

@@ -44,14 +44,14 @@
 /// @page HttpSimpleCallsTOC
 ///
 /// <ul>
-///  <li>@ref HttpSimpleAll "POST /_api/simple/all"</li>
+///  <li>@ref HttpSimpleAll "PUT /_api/simple/all"</li>
-///  <li>@ref HttpSimpleByExample "POST /_api/simple/by-example"</li>
+///  <li>@ref HttpSimpleByExample "PUT /_api/simple/by-example"</li>
-///  <li>@ref HttpSimpleFirstExample "POST /_api/simple/first-example"</li>
+///  <li>@ref HttpSimpleFirstExample "PUT /_api/simple/first-example"</li>
-///  <li>@ref HttpSimpleAny "POST /_api/simple/any"</li>
+///  <li>@ref HttpSimpleAny "PUT /_api/simple/any"</li>
-///  <li>@ref HttpSimpleRange "POST /_api/simple/range"</li>
+///  <li>@ref HttpSimpleRange "PUT /_api/simple/range"</li>
-///  <li>@ref HttpSimpleNear "POST /_api/simple/near"</li>
+///  <li>@ref HttpSimpleNear "PUT /_api/simple/near"</li>
-///  <li>@ref HttpSimpleWithin "POST /_api/simple/within"</li>
+///  <li>@ref HttpSimpleWithin "PUT /_api/simple/within"</li>
-///  <li>@ref HttpSimpleFulltext "POST /_api/simple/fulltext"</li>
+///  <li>@ref HttpSimpleFulltext "PUT /_api/simple/fulltext"</li>
 ///  <li>@ref HttpSimpleRemoveByExample "PUT /_api/simple/remove-by-example"</li>
 /// </ul>
 ////////////////////////////////////////////////////////////////////////////////

arangod/Documentation/index-cap.dox

@@ -46,7 +46,7 @@
 ////////////////////////////////////////////////////////////////////////////////
 /// @page IndexCap Cap Constraint
 ///
-/// This is an introduction to ArangoDB's size restrictions aka cap for
+/// This is an introduction to ArangoDB's size restrictions aka cap constraints for
 /// collections.
 ///
 /// @EMBEDTOC{IndexCapTOC}
@@ -54,9 +54,10 @@
 /// @section IndexCapIntro Cap Constraint
 /////////////////////////////////////////
 ///
-/// It is possible to restrict the size of collection. If you add a document and
+/// It is possible to restrict the size of collections. If you add a document and
 /// the size exceeds the limit, then the least recently created or updated
-/// document will be dropped.
+/// document will be dropped. The size of a collection is measured in the number
+/// of (non-deleted) documents a collection contains.
 ///
 /// @section IndexCapShell Accessing Cap Constraints from the Shell
 ///////////////////////////////////////////////////////////////////

arangod/Documentation/index-fulltext.dox

@@ -71,7 +71,7 @@
 ///  <li>@ref IndexFulltextHttp
 ///   <ul>
 ///    <li>@ref IndexFulltextHttpEnsureFulltextIndex "POST /_api/index"</li>
-///    <li>@ref IndexFulltextHttpFulltext "POST /_api/simple/fulltext"</li>
+///    <li>@ref IndexFulltextHttpFulltext "PUT /_api/simple/fulltext"</li>
 ///   </ul>
 ///  </li>
 /// </ul>

arangod/Documentation/index-geo.dox

@@ -99,8 +99,8 @@
 ///  <li>@ref IndexGeoHttp
 ///   <ul>
 ///    <li>@ref IndexGeoHttpEnsureGeo "POST /_api/index"</li>
-///    <li>@ref IndexGeoHttpNear "POST /_api/simple/near"</li>
+///    <li>@ref IndexGeoHttpNear "PUT /_api/simple/near"</li>
-///    <li>@ref IndexGeoHttpWithin "POST /_api/simple/within"</li>
+///    <li>@ref IndexGeoHttpWithin "PUT /_api/simple/within"</li>
 ///   </ul>
 ///  </li>
 /// </ul>

arangod/Documentation/index-hash.dox

@@ -76,8 +76,8 @@
 ///  <li>@ref IndexHashHttp
 ///   <ul>
 ///    <li>@ref IndexHashHttpEnsureHash "POST /_api/index"</li>
-///    <li>@ref IndexHashHttpByExample "POST /_api/simple/by-example"</li>
+///    <li>@ref IndexHashHttpByExample "PUT /_api/simple/by-example"</li>
-///    <li>@ref IndexHashHttpFirstExample "POST /_api/simple/first-example"</li>
+///    <li>@ref IndexHashHttpFirstExample "PUT /_api/simple/first-example"</li>
 ///   </ul>
 ///  </li>
 /// </ul>

arangod/Documentation/index-skiplist.dox

@@ -76,7 +76,7 @@
 ///  <li>@ref IndexSkiplistHttp
 ///   <ul>
 ///    <li>@ref IndexSkiplistHttpEnsureSkiplist "POST /_api/index"</li>
-///    <li>@ref IndexSkiplistHttpRange "POST /_api/simple/range"</li>
+///    <li>@ref IndexSkiplistHttpRange "PUT /_api/simple/range"</li>
 ///   </ul>
 ///  </li>
 /// </ul>

js/actions/system/api-index.js

@@ -157,12 +157,12 @@ function GET_api_index (req, res) {
 ///
 /// @REST{POST /_api/index?collection=@FA{collection-name}}
 ///
-/// Creates a cap constraint for the collection @FA{collection-name}, if
+/// Creates a cap constraint (@ref IndexCapIntro) for the collection @FA{collection-name}, if
 /// it does not already exist. Expects an object containing the index details.
 ///
 /// - @LIT{type}: must be equal to @LIT{"cap"}.
 ///
-/// - @LIT{size}: The maximal size of documents.
+/// - @LIT{size}: The maximal number of documents for the collection.
 ///
 /// If the index does not already exist and could be created, then a @LIT{HTTP
 /// 201} is returned. If the index already exists, then a @LIT{HTTP 200} is
@@ -197,7 +197,7 @@ function POST_api_index_cap (req, res, collection, body) {
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief creates a geo index
 ///
-/// @RESTHEADER{GET /_api/index,creates a geo-spatial index}
+/// @RESTHEADER{POST /_api/index,creates a geo-spatial index}
 ///
 /// @REST{POST /_api/index?collection=@FA{collection-name}}
 ///
@@ -569,10 +569,11 @@ function POST_api_index_bitarray (req, res, collection, body) {
 /// Creates a new index in the collection @FA{collection-name}. Expects
 /// an object containing the index details.
 ///
-/// See @ref IndexCapHttp, @ref IndexGeoHttp, @ref IndexHashHttp, and
+/// See @ref IndexCapHttp, @ref IndexGeoHttp, @ref IndexHashHttp, 
-/// @ref IndexSkiplistHttp for details. By default, non-unique indexes will
+/// @ref IndexFulltextHttp, and @ref IndexSkiplistHttp for details. 
-/// be created. To change this, use the @LIT{unique} attribute in the index details
+///
-/// and set its value to @LIT{true}.
+/// By default, non-unique indexes will be created. To change this, use the 
+/// @LIT{unique} attribute in the index details and set its value to @LIT{true}.
 ///
 /// If the index does not already exist and could be created, then a @LIT{HTTP
 /// 201} is returned.  If the index already exists, then a @LIT{HTTP 200} is