]> Kevux Git Server - fll/commitdiff
Cleanup: Upper case the first word of each sentence in documentation comments and...
authorKevin Day <kevin@kevux.org>
Thu, 13 Jul 2023 03:29:32 +0000 (22:29 -0500)
committerKevin Day <kevin@kevux.org>
Thu, 13 Jul 2023 03:29:32 +0000 (22:29 -0500)
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
level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_signed_detect.3
level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_partial_to_unsigned_detect.3
level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_signed_detect.3
level_1/fl_conversion/data/documentation/man/man3/fl_conversion_dynamic_to_unsigned_detect.3

index ce84c3f80f75127a936afc66f61aaf1db0a7852f..6993882d995ba7702d5b812ac154701d16e4d378 100644 (file)
@@ -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.
index a8e3979557316b3200a17619ad7f82e81b634d07..f3d5752e1b0613bc1acb997a20b5bd4c797688b7 100644 (file)
@@ -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
index 7b07769191b7e4767630dfbf89772a29241041eb..8c9966e1f806636a8115d9efc021e7d9a5a7d9ca 100644 (file)
@@ -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
index 46bcb5d089e380c01c20b6077b622162cac28203..0645747d7285ef52485227715c59ec7df0835f2b 100644 (file)
@@ -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
index 31340fb95fee3cbf9b716db5d63c8aaf09e82bb0..d082085630df833179469899cc5bec8c5e0b653b 100644 (file)
@@ -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