[ci skip] Add return types to library docs

Author: narfbg

user_guide_src/source/libraries/benchmark.rst

@@ -135,18 +135,18 @@ Class Reference
 
 	.. method:: mark($name)
 
-		:param string $name: the name you wish to assign to your marker
-		:returns: void
+		:param	string	$name: the name you wish to assign to your marker
+		:rtype:	void
 
 		Sets a benchmark marker.
 
-
 	.. method:: elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]])
 
-		:param string $point1: a particular marked point
-		:param string $point2: a particular marked point
-		:param int $decimals: number of decimal places for precision
-		:returns: string
+		:param	string	$point1: a particular marked point
+		:param	string	$point2: a particular marked point
+		:param	int	$decimals: number of decimal places for precision
+		:returns:	Elapsed time
+		:rtype:	string
 
 		Calculates and returns the time difference between two marked points.
 
@@ -158,7 +158,8 @@ Class Reference
 
 	.. method:: memory_usage()
 
-		:returns: string
+		:returns:	Memory usage info
+		:rtype:	string
 
 		Simply returns the ``{memory_usage}`` marker.
 

user_guide_src/source/libraries/caching.rst

@@ -56,8 +56,9 @@ Class Reference
 
 	.. method:: is_supported($driver)
 
-		:param string $driver: the name of the caching driver
-		:returns: TRUE if supported, FALSE if not
+		:param	string	$driver: the name of the caching driver
+		:returns:	TRUE if supported, FALSE if not
+		:rtype:	bool
 
 		This method is automatically called when accessing drivers via
 		``$this->cache->get()``. However, if the individual drivers are used,
@@ -75,8 +76,9 @@ Class Reference
 
 	.. method:: get($id)
 
-		:param string $id: name of cached item
-		:returns: The item if it exists, FALSE if it does not
+		:param	string	$id: Cache item name
+		:returns:	Item value or FALSE if not found
+		:rtype:	mixed
 
 		This method will attempt to fetch an item from the cache store. If the
 		item does not exist, the method will return FALSE.
@@ -86,11 +88,12 @@ Class Reference
 
 	.. method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
 
-		:param string $id: name of the cached item
-		:param mixed $data: the data to save
-		:param int $ttl: Time To Live, in seconds (default 60)
-		:param bool $raw: Whether to store the raw value
-		:returns: TRUE on success, FALSE on failure
+		:param	string	$id: Cache item name
+		:param	mixed	$data: the data to save
+		:param	int	$ttl: Time To Live, in seconds (default 60)
+		:param	bool	$raw: Whether to store the raw value
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	string
 
 		This method will save an item to the cache store. If saving fails, the
 		method will return FALSE.
@@ -103,8 +106,9 @@ Class Reference
 
 	.. method:: delete($id)
 
-		:param string $id: name of cached item
-		:returns: TRUE if deleted, FALSE if the deletion fails
+		:param	string	$id: name of cached item
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method will delete a specific item from the cache store. If item
 		deletion fails, the method will return FALSE.
@@ -114,9 +118,10 @@ Class Reference
 
 	.. method:: increment($id[, $offset = 1])
 
-		:param string $id: Cache ID
-		:param int $offset: Step/value to add
-		:returns: New value on success, FALSE on failure
+		:param	string	$id: Cache ID
+		:param	int	$offset: Step/value to add
+		:returns:	New value on success, FALSE on failure
+		:rtype:	mixed
 
 		Performs atomic incrementation of a raw stored value.
 		::
@@ -129,9 +134,10 @@ Class Reference
 
 	.. method:: decrement($id[, $offset = 1])
 
-		:param string $id: Cache ID
-		:param int $offset: Step/value to reduce by
-		:returns: New value on success, FALSE on failure
+		:param	string	$id: Cache ID
+		:param	int	$offset: Step/value to reduce by
+		:returns:	New value on success, FALSE on failure
+		:rtype:	mixed
 
 		Performs atomic decrementation of a raw stored value.
 		::
@@ -144,7 +150,8 @@ Class Reference
 
 	.. method:: clean()
 
-		:returns: TRUE if deleted, FALSE if the deletion fails
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method will 'clean' the entire cache. If the deletion of the
 		cache files fails, the method will return FALSE.
@@ -154,7 +161,8 @@ Class Reference
 
 	.. method:: cache_info()
 
-		:returns: information on the entire cache
+		:returns:	Information on the entire cache database
+		:rtype:	mixed
 
 		This method will return information on the entire cache.
 		::
@@ -166,8 +174,9 @@ Class Reference
 
 	.. method:: get_metadata($id)
 
-		:param string $id: name of cached item
-		:returns: metadadta for the cached item
+		:param	string	$id: Cache item name
+		:returns:	Metadata for the cached item
+		:rtype:	mixed
 
 		This method will return detailed information on a specific item in the
 		cache.

user_guide_src/source/libraries/calendar.rst

@@ -201,48 +201,49 @@ Class Reference
 
 	.. method:: initialize([$config = array()])
 
-		:param array $config: config preferences
-		:returns: void
+		:param	array	$config: Configuration parameters
+		:rtype:	void
 
 		Initializes the Calendaring preferences. Accepts an associative array as input, containing display preferences.
 
-
 	.. method:: generate([$year = ''[, $month = ''[, $data = array()]]])
 
-		:param int $year: the year
-		:param int $month: the month
-		:param array $data: the data to be shown in the calendar cells
-		:returns: string
+		:param	int	$year: Year
+		:param	int	$month: Month
+		:param	array	$data: Data to be shown in the calendar cells
+		:returns:	HTML-formatted calendar
+		:rtype:	string
 
 		Generate the calendar.
 
 
 	.. method:: get_month_name($month)
 
-		:param int $month: the numeric month
-		:returns: string
+		:param	int	$month: Month
+		:returns:	Month name
+		:rtype:	string
 
 		Generates a textual month name based on the numeric month provided.
 
-
 	.. method:: get_day_names($day_type = '')
 
-		:param string $day_type: one of 'long', 'short', or 'abr'
-		:returns: array
+		:param	string	$day_type: 'long', 'short', or 'abr'
+		:returns:	Array of day names
+		:rtype:	array
 
 		Returns an array of day names (Sunday, Monday, etc.) based on the type
 		provided. Options: long, short, abr. If no ``$day_type`` is provided (or
 		if an invalid type is provided) this method will return the "abbreviated"
 		style.
 
-
 	.. method:: adjust_date($month, $year)
 
-		:param int $month: the month
-		:param int $year: the year
-		:returns: array
+		:param	int	$month: Month
+		:param	int	$year: Year
+		:returns:	An associative array containing month and year
+		:rtype:	array
 
-		This method makes usre that you have a valid month/year. For example, if
+		This method makes sure that you have a valid month/year. For example, if
 		you submit 13 as the month, the year will increment and the month will
 		become January::
 
@@ -256,30 +257,30 @@ Class Reference
 				[year] => '2014'
 			)
 
-
 	.. method:: get_total_days($month, $year)
 
-		:param int $month: the month
-		:param int $year: the year
-		:returns: int
+		:param	int	$month: Month
+		:param	int	$year: Year
+		:returns:	Count of days in the specified month
+		:rtype:	int
 
 		Total days in a given month::
 
 			echo $this->calendar->get_total_days(2, 2012);
 			// 29
 
-
 	.. method:: default_template()
 
-		:returns: array
+		:returns:	An array of template values
+		:rtype:	array
 
 		Sets the default template. This method is used when you have not created
 		your own template.
 
 
 	.. method:: parse_template()
 
-		:returns: void
+		:rtype:	void
 
 		Harvests the data within the template ``{pseudo-variables}`` used to
 		display the calendar.

user_guide_src/source/libraries/cart.rst

@@ -275,92 +275,95 @@ Class Reference
 
 	.. method:: insert([$items = array()])
 
-		:param array $items: the items to insert into the cart
-		:returns: bool
+		:param	array	$items: Items to insert into the cart
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Insert items into the cart and save it to the session table. Returns TRUE
 		on success and FALSE on failure.
 
 
 	.. method:: update([$items = array()])
 
-		:param array $items: the items to update in the cart
-		:returns: bool
+		:param	array	$items: Items to update in the cart
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method permits the quantity of a given item to be changed.
 		Typically it is called from the "view cart" page if a user makes changes
 		to the quantity before checkout. That array must contain the product ID
 		and quantity for each item.
 
-
 	.. method:: remove($rowid)
 
-		:param int $rowid: the ID of the item to remove from the cart
-		:returns: bool
+		:param	int	$rowid: ID of the item to remove from the cart
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Allows you to remove an item from the shopping cart by passing it the
 		``$rowid``.
 
-
 	.. method:: total()
 
-		:returns: int
+		:returns:	Total amount
+		:rtype:	int
 
 		Displays the total amount in the cart.
 
 
 	.. method:: total_items()
 
-		:returns: int
+		:returns:	Total amount of items in the cart
+		:rtype:	int
 
 		Displays the total number of items in the cart.
 
 
 	.. method:: contents([$newest_first = FALSE])
 
-		:param bool $newest_first: order the array with newest first?
-		:returns: array
+		:param	bool	$newest_first: Whether to order the array with newest items first
+		:returns:	An array of cart contents
+		:rtype:	array
 
 		Returns an array containing everything in the cart. You can sort the
 		order by which the array is returned by passing it TRUE where the contents
 		will be sorted from newest to oldest, otherwise it is sorted from oldest
 		to newest.
 
-
 	.. method:: get_item($row_id)
 
-		:param int $row_id: the row ID to retrieve
-		:returns: array
+		:param	int	$row_id: Row ID to retrieve
+		:returns:	Array of item data
+		:rtype:	array
 
 		Returns an array containing data for the item matching the specified row
 		ID, or FALSE if no such item exists.
 
-
 	.. method:: has_options($row_id = '')
 
-		:param int $row_id: the row ID to inspect
-		:returns: bool
+		:param	int	$row_id: Row ID to inspect
+		:returns:	TRUE if options exist, FALSE otherwise
+		:rtype:	bool
 
 		Returns TRUE (boolean) if a particular row in the cart contains options.
-		This method is designed to be used in a loop with :meth:contents:, since
+		This method is designed to be used in a loop with ``contents()``, since
 		you must pass the rowid to this function, as shown in the Displaying
 		the Cart example above.
 
-
 	.. method:: product_options([$row_id = ''])
 
-		:param int $row_id: the row ID
-		:returns: array
+		:param	int	$row_id: Row ID
+		:returns:	Array of product options
+		:rtype:	array
 
 		Returns an array of options for a particular product. This method is
-		designed to be used in a loop with :meth:contents:, since you
+		designed to be used in a loop with ``contents()``, since you
 		must pass the rowid to this method, as shown in the Displaying the
 		Cart example above.
 
-
 	.. method:: destroy()
 
-		:returns: void
+		:rtype: void
 
 		Permits you to destroy the cart. This method will likely be called
 		when you are finished processing the customer's order.