From 6d3ecd5b706b9670526c1aab0602acbeec380166 Mon Sep 17 00:00:00 2001 From: Alex Kotov Date: Sun, 30 Jan 2022 17:37:33 +0500 Subject: [PATCH] Ruby: add doc comments --- pkgs/ruby/lib/kernaux.rb | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/pkgs/ruby/lib/kernaux.rb b/pkgs/ruby/lib/kernaux.rb index 2dfd8fc..1787da6 100644 --- a/pkgs/ruby/lib/kernaux.rb +++ b/pkgs/ruby/lib/kernaux.rb @@ -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. #