~donmcc/astr

ab0cbaa5712e23d81a7bfaa3988a9d8088b05471 — Don McCaughey 1 year, 1 month ago 5ed773f
Add missing `const` to function signatures in docs.

Update the readme file and man page to incorporate the function
signature changes in the previous commit (5ed773f).
2 files changed, 6 insertions(+), 6 deletions(-)

M README.md
M astr.3
M README.md => README.md +3 -3
@@ 44,7 44,7 @@ Allocate an empty string.
    astr_alloc_formatted(char const *format, ...);

    char *
    astr_alloc_formatted_from_va_list(char const *format, va_list arguments);
    astr_alloc_formatted_from_va_list(char const *format, va_list const arguments);

Allocate a formatted string.



@@ 70,7 70,7 @@ Compare the bytes of two strings for equality; `s1` and `s2` may be `NULL`.
    astr_formatted_length(char const *format, ...);

    size_t
    astr_formatted_length_from_va_list(char const *format, va_list arguments);
    astr_formatted_length_from_va_list(char const *format, va_list const arguments);

Calculate the length in bytes needed for the formatted string.



@@ 78,7 78,7 @@ Calculate the length in bytes needed for the formatted string.
    astr_realloc_append_formatted(char **s, char const *format, ...);

    int
    astr_realloc_append_foramtted_from_va_list(char **s, char const *format, va_list arguments);
    astr_realloc_append_foramtted_from_va_list(char **s, char const *format, va_list const arguments);

Append formatted characters to the end of the given string, returning 0 on 
success and -1 on error.

M astr.3 => astr.3 +3 -3
@@ 20,7 20,7 @@
.Ft char *
.Fn astr_alloc_formatted "char const *format" "..."
.Ft char *
.Fn astr_alloc_formatted_from_va_list "char const *format" "va_list arguments"
.Fn astr_alloc_formatted_from_va_list "char const *format" "va_list const arguments"
.Ft int
.Fn astr_cmp "char const *s1" "char const *s2"
.Ft bool


@@ 30,11 30,11 @@
.Ft size_t
.Fn astr_formatted_length "char const *format" "..."
.Ft size_t
.Fn astr_formatted_length_from_va_list "char const *format" "va_list arguments"
.Fn astr_formatted_length_from_va_list "char const *format" "va_list const arguments"
.Ft int
.Fn astr_realloc_append_formatted "char **s" "char const *format"
.Ft int
.Fn astr_realloc_append_formatted_from_va_list "char **s" "char const *format" "va_list arguments"
.Fn astr_realloc_append_formatted_from_va_list "char **s" "char const *format" "va_list const arguments"
.Sh DESCRIPTION
The
.Nm astr