[gnutls-devel] GnuTLS | doc: Fix typo and improve doc (!1869)

[Read-only notification of GnuTLS library development activities]

Sahil Siddiq created a merge request: https://gitlab.com/gnutls/gnutls/-/merge_requests/1869

Project:Branches: valdaarhun/gnutls:doc_fix to gnutls/gnutls:master
Author:   Sahil Siddiq




<!-- Add a description of the new feature/bug fix. Reference any relevant bugs. -->

* doc: Fix typo and improve doc

The description of "gnutls_psk_allocate_client_credentials" incorrectly
states that sc is a pointer to a "gnutls_psk_server_credentials_t". sc
is a pointer to a "gnutls_psk_client_credentials_t".

In the description of "gnutls_credentials_set", mention the type that
the cred parameter should be when using GNUTLS_CRD_PSK.

Signed-off-by: Sahil Siddiq <sahilcdq at proton.me>

## Checklist
 * [x] Commits have `Signed-off-by:` with name/author being identical to the commit author
 * [ ] Code modified for feature
 * [ ] Test suite updated with functionality tests
 * [ ] Test suite updated with negative tests
 * [ ] Documentation updated / NEWS entry present (for non-trivial changes)
 * [ ] CI timeout is 2h or higher (see Settings/CICD/General pipelines/Timeout)

## Reviewer's checklist:
 * [ ] Any issues marked for closing are addressed
 * [ ] There is a test suite reasonably covering new functionality or modifications
 * [ ] Function naming, parameters, return values, types, etc., are consistent and according to `CONTRIBUTION.md`
 * [ ] This feature/change has adequate documentation added
 * [ ] No obvious mistakes in the code

-- 
Reply to this email directly or view it on GitLab: https://gitlab.com/gnutls/gnutls/-/merge_requests/1869
You're receiving this email because of your account on gitlab.com.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.gnupg.org/pipermail/gnutls-devel/attachments/20240822/42919f95/attachment-0001.html>