tailix/libkernaux
1
0
Fork 0
mirror of https://github.com/tailix/libkernaux.git synced 2025-04-21 17:42:26 -04:00
Code Releases Activity

Ruby: add doc comments

Browse source
This commit is contained in:
Alex Kotov 2022-01-30 17:37:33 +05:00
parent 262d9376bd
commit 6d3ecd5b70
Signed by: kotovalexarian
GPG key ID: 553C0EBBEB5D5F08
1 changed files with 23 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
pkgs/ruby/lib/kernaux.rb
View file

@ -131,10 +131,10 @@ module KernAux
# which is an alias to a valid integer value. Positive integers and lowercase
# symbols mean lowercase output when base is greater than 10. Negative
# integers and uppercase symbols mean uppercase output when base is greater
# than 10. Aliases are: `b`, `B` - 2; `o`, `O` - 8; `d`, `D` - 10; `h`, `x` -
# 16 (lowercase); `H`, `X` - -10 (uppercase).
# than 10. Aliases are: `:b`, `:B` - 2; `:o`, `:O` - 8; `:d`, `:D` - 10; `:h`,
# `:x` - 16 (lowercase); `:H`, `:X` - -10 (uppercase).
#
# @param number [Integer] a number between 0 and `UINT64_MAX` - 1
# @param number [Integer] a number between 0 and `UINT64_MAX`
# @param base [Integer, Symbol] base of a numeral system
# @return [String]
#
@ -143,6 +143,26 @@ module KernAux
# @see .itoa Convert signed integers
##
##
# @!method itoa(number, base)
# Convert `int64_t` to a string in multiple numeral systems.
#
# Base can be a positive or negative integer between 2 and 36, or a symbol
# which is an alias to a valid integer value. Positive integers and lowercase
# symbols mean lowercase output when base is greater than 10. Negative
# integers and uppercase symbols mean uppercase output when base is greater
# than 10. Aliases are: `:b`, `:B` - 2; `:o`, `:O` - 8; `:d`, `:D` - 10; `:h`,
# `:x` - 16 (lowercase); `:H`, `:X` - -10 (uppercase).
#
# @param number [Integer] a number between `INT64_MIN` and `INT64_MAX`
# @param base [Integer, Symbol] base of a numeral system
# @return [String]
#
# @raise [InvalidNtoaBaseError] base is invalid
#
# @see .utoa Convert unsigned integers
##
##
# Our base class for runtime errors.
#