Commit d0e25a8

Richard Luby <richluby@gmail.com>
2016-12-24 05:29:21
updated documentation
1 parent 3f97761
Changed files (2)
doc/web_api.md
@@ -156,7 +156,9 @@ Formatted:
 ## `API_ROOT/questions/categories`
 
 ### GET Requests
-- Returns the list of all categories known by the server
+- Returns the array of all categories known by the server
+
+The array is of `Category` (found in `structures.go`).
 
 ### POST Requests
 - No result
structures.go
@@ -71,10 +71,6 @@ type ClientTest struct {
 type CountingSemaphore struct {
 	counter    chan bool //store empty structs since they take 0 memory
 	locksTaken int
-	// P           func()
-	// V           func()
-	// Queued      func() int
-	// SetCapacity (int)
 }
 
 // Category stores information related to categories
@@ -82,11 +78,11 @@ type CountingSemaphore struct {
 // sending the structures over the wire.
 type Category struct {
 	Children []int
-	// stores the indices to the array in
-	// 'categoricalData' of the children. Similar to a pointer,
+	// stores the indices of the array in
+	// 'categories' of the children. Similar to a pointer,
 	// but can be sent across the network.
 
-	Parent int // the index in the array of 'categoricalData'
+	Parent int // the index in the array of 'categories'
 	// a negative value indicates no parent
 	fullCategoryPath,
 	Value string // leaf portion of path