Clarified docs for floor(), ceiling() and round().

This commit is contained in:
Yorick Peterse 2014-08-28 00:01:33 +02:00
parent 543112dcdc
commit 8fb8fb17b6
1 changed files with 6 additions and 5 deletions

View File

@ -1188,7 +1188,8 @@ module Oga
## ##
# Processes the `floor()` function call. # Processes the `floor()` function call.
# #
# This function floors a numeric value and returns the result as a float. # This function call rounds the 1st argument down to the closest integer,
# and then returns that number as a float.
# #
# @param [Oga::XML::NodeSet] context # @param [Oga::XML::NodeSet] context
# @param [Oga::XPath::Node] expression # @param [Oga::XPath::Node] expression
@ -1203,8 +1204,8 @@ module Oga
## ##
# Processes the `ceiling()` function call. # Processes the `ceiling()` function call.
# #
# This function returns the ceiling of a numeric value, the result is # This function call rounds the 1st argument up to the closest integer,
# returned as a float. # and then returns that number as a float.
# #
# @param [Oga::XML::NodeSet] context # @param [Oga::XML::NodeSet] context
# @param [Oga::XPath::Node] expression # @param [Oga::XPath::Node] expression
@ -1219,8 +1220,8 @@ module Oga
## ##
# Processes the `round()` function call. # Processes the `round()` function call.
# #
# This function call rounds the 1st argument to the closest integer number # This function call rounds the 1st argument to the closest integer, and
# and then returns that number as a float. # then returns that number as a float.
# #
# @param [Oga::XML::NodeSet] context # @param [Oga::XML::NodeSet] context
# @param [Oga::XPath::Node] expression # @param [Oga::XPath::Node] expression