From 5802017b7fade1c6f1dc5b03aabb36488574cede Mon Sep 17 00:00:00 2001
From: Eshan Kelkar <eshankelkar@galorithm.com>
Date: Mon, 27 May 2024 12:06:14 +0530
Subject: [PATCH] options.c: Use a consistent scheme for datatype in
 documentation

For the data type of the third argument <value> corresponding to the
second argument <option type>, the documentation of ssh_options_set()
and ssh_bind_options_set() uses a scheme of (data_type *) in some
places whereas (data_type) in other places. Here data_type is the type
of the value which is to be set (it can be const char *, int, bool,
long, ssh_key etc)

This commit removes this inconsistency and uses the (data_type)
scheme everywhere.

Signed-off-by: Eshan Kelkar <eshankelkar@galorithm.com>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
---
 src/options.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/options.c b/src/options.c
index b402f50a..af729fb1 100644
--- a/src/options.c
+++ b/src/options.c
@@ -314,7 +314,7 @@ int ssh_options_set_algo(ssh_session session,
  *                The hostname or ip address to connect to (const char *).
  *
  *              - SSH_OPTIONS_PORT:
- *                The port to connect to (unsigned int *).
+ *                The port to connect to (unsigned int).
  *
  *              - SSH_OPTIONS_PORT_STR:
  *                The port to connect to (const char *).
@@ -575,7 +575,7 @@ int ssh_options_set_algo(ssh_session session,
  *                configuration option as they are considered completely broken.
  *                Setting 0 will revert the value to defaults.
  *                Default is 1024 bits or 2048 bits in FIPS mode.
- *                (int *)
+ *                (int)
 
  *              - SSH_OPTIONS_IDENTITY_AGENT
  *                Set the path to the SSH agent socket. If unset, the
@@ -2012,13 +2012,13 @@ static int ssh_bind_set_algo(ssh_bind sshbind,
  *                        Set the IP address to bind (const char *).
  *
  *                      - SSH_BIND_OPTIONS_BINDPORT:
- *                        Set the port to bind (unsigned int *).
+ *                        Set the port to bind (unsigned int).
  *
  *                      - SSH_BIND_OPTIONS_BINDPORT_STR:
  *                        Set the port to bind (const char *).
  *
  *                      - SSH_BIND_OPTIONS_LOG_VERBOSITY:
- *                        Set the session logging verbosity (int *).
+ *                        Set the session logging verbosity (int).
  *                        The logging verbosity should have one of the
  *                        following values, which are listed in order
  *                        of increasing verbosity.  Every log message