issue #568: fixed HttpCollection docs

Documentation/ImplementorManual/HttpCollection.md

@@ -60,7 +60,27 @@ Getting Information about a Collection {#HttpCollectionReading}
 ---------------------------------------------------------------
 
 @anchor HttpCollectionRead
-@copydetails JSF_get_api_collection
+@copydetails JSA_get_api_collection_name
+
+@CLEARPAGE
+@anchor HttpCollectionReadProperties
+@copydetails JSA_get_api_collection_properties
+
+@CLEARPAGE
+@anchor HttpCollectionReadCount
+@copydetails JSA_get_api_collection_count
+
+@CLEARPAGE
+@anchor HttpCollectionReadFigures
+@copydetails JSA_get_api_collection_figures
+
+@CLEARPAGE
+@anchor HttpCollectionReadRevision
+@copydetails JSA_get_api_collection_revision
+
+@CLEARPAGE
+@anchor HttpCollectionReadChecksum
+@copydetails JSA_get_api_collection_checksum
 
 @CLEARPAGE
 @anchor HttpCollectionReadAll

Documentation/ImplementorManual/HttpCollectionTOC.md

@@ -11,12 +11,11 @@ TOC {#HttpCollectionTOC}
       - @ref HttpCollectionTruncate "PUT /_api/collection/collection-name/truncate"
     - @ref HttpCollectionReading
       - @ref HttpCollectionRead "GET /_api/collection/collection-name"
-      - @ref HttpCollectionRead "GET /_api/collection/collection-name/properties"
-      - @ref HttpCollectionRead "GET /_api/collection/collection-name/count"
-      - @ref HttpCollectionRead "GET /_api/collection/collection-name/figures"
-      - @ref HttpCollectionRead "GET /_api/collection/collection-name/revision"
-      - @ref HttpCollectionRead "GET /_api/collection/collection-name/checksum"
-      - @ref HttpCollectionRead "GET /_api/collection/collection-name"
+      - @ref HttpCollectionReadProperties "GET /_api/collection/collection-name/properties"
+      - @ref HttpCollectionReadCount "GET /_api/collection/collection-name/count"
+      - @ref HttpCollectionReadFigures "GET /_api/collection/collection-name/figures"
+      - @ref HttpCollectionReadRevision "GET /_api/collection/collection-name/revision"
+      - @ref HttpCollectionReadChecksum "GET /_api/collection/collection-name/checksum"
       - @ref HttpCollectionReadAll "GET /_api/collection/"
     - @ref HttpCollectionChanging
       - @ref HttpCollectionLoad "PUT /_api/collection/collection-name/load"

js/actions/api-collection.js

@@ -335,9 +335,10 @@ function get_api_collections (req, res) {
 }
 
 ////////////////////////////////////////////////////////////////////////////////
+/// @fn JSA_get_api_collection_name
 /// @brief returns a collection
 ///
-/// @RESTHEADER{GET /_api/collection/{collection-name},reads a collection}
+/// @RESTHEADER{GET /_api/collection/{collection-name},returns information about a collection}
 ///
 /// @RESTURLPARAMETERS
 ///
@@ -373,8 +374,9 @@ function get_api_collections (req, res) {
 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
+/// @fn JSA_get_api_collection_properties
 ///
-/// @RESTHEADER{GET /_api/collection/{collection-name}/properties,reads a collection with properties}
+/// @RESTHEADER{GET /_api/collection/{collection-name}/properties,reads the properties of a collection}
 ///
 /// @RESTURLPARAMETERS
 ///
@@ -441,8 +443,9 @@ function get_api_collections (req, res) {
 ////////////////////////////////////////////////////////////////////////////
 
 ////////////////////////////////////////////////////////////////////////////
+/// @fn JSA_get_api_collection_count
 ///
-/// @RESTHEADER{GET /_api/collection/{collection-name}/count,reads a collection with count}
+/// @RESTHEADER{GET /_api/collection/{collection-name}/count,returns the number of documents in a collection}
 ///
 /// @RESTURLPARAMETERS
 ///
@@ -487,8 +490,9 @@ function get_api_collections (req, res) {
 ////////////////////////////////////////////////////////////////////////////
 
 ////////////////////////////////////////////////////////////////////////////
+/// @fn JSA_get_api_collection_figures
 ///
-/// @RESTHEADER{GET /_api/collection/{collection-name}/figures,reads a collection with stats}
+/// @RESTHEADER{GET /_api/collection/{collection-name}/figures,returns the stats for a collection}
 ///
 /// @RESTURLPARAMETERS
 ///
@@ -559,8 +563,9 @@ function get_api_collections (req, res) {
 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
+/// @fn JSA_get_api_collection_revision
 ///
-/// @RESTHEADER{GET /_api/collection/{collection-name}/revision, reads a collection with revision id}
+/// @RESTHEADER{GET /_api/collection/{collection-name}/revision,return a collection revision id}
 ///
 /// @RESTURLPARAMETERS
 ///
@@ -604,8 +609,9 @@ function get_api_collections (req, res) {
 ////////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
+/// @fn JSA_get_api_collection_checksum
 ///
-/// @RESTHEADER{GET /_api/collection/{collection-name}/checksum, returns a checksum for the collection}
+/// @RESTHEADER{GET /_api/collection/{collection-name}/checksum,returns a checksum for the collection}
 ///
 /// @RESTURLPARAMETERS
 ///