From 9ca38aac888642b6948377af5387eee296a09af6 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Wed, 12 Jul 2023 22:29:32 -0500 Subject: [PATCH] Cleanup: Upper case the first word of each sentence in documentation comments and add missing lines in man pages. The man pag generation processed decided to arbitrarily strip out parts of the documentation. Add back the missing lines that I noticed are missing. --- level_1/fl_conversion/c/conversion.h | 40 +++++++++++----------- ...l_conversion_dynamic_partial_to_signed_detect.3 | 10 +++++- ...conversion_dynamic_partial_to_unsigned_detect.3 | 10 +++++- .../man3/fl_conversion_dynamic_to_signed_detect.3 | 10 +++++- .../fl_conversion_dynamic_to_unsigned_detect.3 | 10 +++++- 5 files changed, 56 insertions(+), 24 deletions(-) diff --git a/level_1/fl_conversion/c/conversion.h b/level_1/fl_conversion/c/conversion.h index ce84c3f..6993882 100644 --- a/level_1/fl_conversion/c/conversion.h +++ b/level_1/fl_conversion/c/conversion.h @@ -68,11 +68,11 @@ extern "C" { * This will ignore NULL values. * This will process signed statuses (+/-). * This will detect based types as follows: - * - hexidecimals begin with either '0x' or '0X'. - * - duodecimals begin with either '0d' or '0D'. - * - octals begin with either '0o' or '0O'. - * - binaries begin with either '0b' or '0B'. - * - decimal is used for all other cases. + * - Hexidecimals begin with either '0x' or '0X'. + * - Duodecimals begin with either '0d' or '0D'. + * - Octals begin with either '0o' or '0O'. + * - Binaries begin with either '0b' or '0B'. + * - Decimal is used for all other cases. * * Leading 0's and whitespace are ignored. * Whitespace after the first digit is considered invalid. @@ -146,11 +146,11 @@ extern "C" { * This will ignore NULL values. * This will not process signed statuses (+/-). * This will detect based types as follows: - * - hexidecimals begin with either '0x' or '0X'. - * - duodecimals begin with either '0d' or '0D'. - * - octals begin with either '0o' or '0O'. - * - binaries begin with either '0b' or '0B'. - * - decimal is used for all other cases. + * - Hexidecimals begin with either '0x' or '0X'. + * - Duodecimals begin with either '0d' or '0D'. + * - Octals begin with either '0o' or '0O'. + * - Binaries begin with either '0b' or '0B'. + * - Decimal is used for all other cases. * * Leading 0's and whitespace are ignored. * Whitespace after the first digit is considered invalid. @@ -226,11 +226,11 @@ extern "C" { * This will ignore NULL values. * This will process signed statuses (+/-). * This will detect based types as follows: - * - hexidecimals begin with either '0x' or '0X'. - * - duodecimals begin with either '0d' or '0D'. - * - octals begin with either '0o' or '0O'. - * - binaries begin with either '0b' or '0B'. - * - decimal is used for all other cases. + * - Hexidecimals begin with either '0x' or '0X'. + * - Duodecimals begin with either '0d' or '0D'. + * - Octals begin with either '0o' or '0O'. + * - Binaries begin with either '0b' or '0B'. + * - Decimal is used for all other cases. * * Leading 0's and whitespace are ignored. * Whitespace after the first digit is considered invalid. @@ -301,11 +301,11 @@ extern "C" { * This will ignore NULL values. * This will not process signed statuses (+/-). * This will detect based types as follows: - * - hexidecimals begin with either '0x' or '0X'. - * - duodecimals begin with either '0d' or '0D'. - * - octals begin with either '0o' or '0O'. - * - binaries begin with either '0b' or '0B'. - * - decimal is used for all other cases. + * - Hexidecimals begin with either '0x' or '0X'. + * - Duodecimals begin with either '0d' or '0D'. + * - Octals begin with either '0o' or '0O'. + * - Binaries begin with either '0b' or '0B'. + * - Decimal is used for all other cases. * * Leading 0's and whitespace are ignored. * Whitespace after the first digit is considered invalid. diff --git a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_signed_detect.3 b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_signed_detect.3 index a8e3979..f3d5752 100644 --- a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_signed_detect.3 +++ b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_signed_detect.3 @@ -16,7 +16,15 @@ fl_conversion_dynamic_partial_to_signed_detect .PP Convert a series of positive or negative number characters into an f_number_signed_t. .PP -decimal is used for all other cases. +Hexidecimals begin with either '0x' or '0X'. +.br +Duodecimals begin with either '0d' or '0D'. +.br +Octals begin with either '0o' or '0O'. +.br +Binaries begin with either '0b' or '0B'. +.br +Decimal is used for all other cases. .PP Leading 0's and whitespace are ignored. Whitespace after the first digit is considered invalid. .PP diff --git a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_unsigned_detect.3 b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_unsigned_detect.3 index 7b07769..8c9966e 100644 --- a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_unsigned_detect.3 +++ b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_unsigned_detect.3 @@ -16,7 +16,15 @@ fl_conversion_dynamic_partial_to_unsigned_detect .PP Convert a series of positive number characters into an f_number_unsigned_t. .PP -decimal is used for all other cases. +Hexidecimals begin with either '0x' or '0X'. +.br +Duodecimals begin with either '0d' or '0D'. +.br +Octals begin with either '0o' or '0O'. +.br +Binaries begin with either '0b' or '0B'. +.br +Decimal is used for all other cases. .PP Leading 0's and whitespace are ignored. Whitespace after the first digit is considered invalid. .PP diff --git a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_signed_detect.3 b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_signed_detect.3 index 46bcb5d..0645747 100644 --- a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_signed_detect.3 +++ b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_signed_detect.3 @@ -15,7 +15,15 @@ fl_conversion_dynamic_to_signed_detect .PP Convert a series of positive or negative number characters into an f_number_signed_t. .PP -decimal is used for all other cases. +Hexidecimals begin with either '0x' or '0X'. +.br +Duodecimals begin with either '0d' or '0D'. +.br +Octals begin with either '0o' or '0O'. +.br +Binaries begin with either '0b' or '0B'. +.br +Decimal is used for all other cases. .PP Leading 0's and whitespace are ignored. Whitespace after the first digit is considered invalid. .PP diff --git a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_unsigned_detect.3 b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_unsigned_detect.3 index 31340fb..d082085 100644 --- a/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_unsigned_detect.3 +++ b/level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_unsigned_detect.3 @@ -15,7 +15,15 @@ fl_conversion_dynamic_to_unsigned_detect .PP Convert a series of positive number characters into an f_number_unsigned_t. .PP -decimal is used for all other cases. +Hexidecimals begin with either '0x' or '0X'. +.br +Duodecimals begin with either '0d' or '0D'. +.br +Octals begin with either '0o' or '0O'. +.br +Binaries begin with either '0b' or '0B'. +.br +Decimal is used for all other cases. .PP Leading 0's and whitespace are ignored. Whitespace after the first digit is considered invalid. .PP -- 1.8.3.1