summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEmanuele Torre <torreemanuele6@gmail.com>2023-04-26 01:55:29 +0200
committerDaniel Stenberg <daniel@haxx.se>2023-04-26 10:19:48 +0200
commit73b9d7eb0f21b7b79f7aaa2f9efdacedb46a9af7 (patch)
treeaf2e40e2a6b23f14b026db4a122c0ef2a373335d /docs
parentf98344c4ae7024cb197a74a5a90ff4dc4fcca645 (diff)
downloadcurl-73b9d7eb0f21b7b79f7aaa2f9efdacedb46a9af7.tar.gz
docs/libcurl: minor cleanups
I was reading curl_unescape(3) and I noticed that there was an extra space after the open parenthesis in the SYNOPSIS; I removed the extra space. I also ran a few grep -r commands to find and remove extra spaces after '(' in other files, and to find and replace uses of `T*' instead of `T *'. Some of the instances of `T*` where unnecessary casts that I removed. I also fixed a comment that was misaligned in CURLMOPT_SOCKETFUNCTION.3. And I fixed some formatting inconsistencies: in curl_unescape(3), all function parameter were mentioned with bold text except length, that was mentioned as 'length'; and, in curl_easy_unescape(3), all parameters were mentioned in bold text except url that was italicised. Now they are all mentioned in bold. Documentation is not very consistent in how function parameter are formatted: many pages italicise them, and others display them in bold text; but I think it makes sense to at least be consistent with formatting within the same page. Closes #11027
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/curl_easy_unescape.32
-rw-r--r--docs/libcurl/curl_formadd.34
-rw-r--r--docs/libcurl/curl_unescape.36
-rw-r--r--docs/libcurl/curl_version_info.32
-rw-r--r--docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.36
5 files changed, 10 insertions, 10 deletions
diff --git a/docs/libcurl/curl_easy_unescape.3 b/docs/libcurl/curl_easy_unescape.3
index 51a667fc0..72026eb48 100644
--- a/docs/libcurl/curl_easy_unescape.3
+++ b/docs/libcurl/curl_easy_unescape.3
@@ -39,7 +39,7 @@ that are URL encoded (%XX where XX is a two-digit hexadecimal number) are
converted to their binary versions.
If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_unescape(3)\fP
-will use strlen() on the input \fIurl\fP string to find out the size.
+will use strlen() on the input \fBurl\fP string to find out the size.
If \fBoutlength\fP is non-NULL, the function will write the length of the
returned string in the integer it points to. This allows proper handling even
diff --git a/docs/libcurl/curl_formadd.3 b/docs/libcurl/curl_formadd.3
index 756071a5d..280ffadf7 100644
--- a/docs/libcurl/curl_formadd.3
+++ b/docs/libcurl/curl_formadd.3
@@ -176,8 +176,8 @@ for the curl handle.
See example below.
.SH EXAMPLE
.nf
- struct curl_httppost* post = NULL;
- struct curl_httppost* last = NULL;
+ struct curl_httppost *post = NULL;
+ struct curl_httppost *last = NULL;
char namebuffer[] = "name buffer";
long namelength = strlen(namebuffer);
char buffer[] = "test buffer";
diff --git a/docs/libcurl/curl_unescape.3 b/docs/libcurl/curl_unescape.3
index b2a83b2de..70645fe6c 100644
--- a/docs/libcurl/curl_unescape.3
+++ b/docs/libcurl/curl_unescape.3
@@ -28,7 +28,7 @@ curl_unescape - URL decodes the given string
.nf
#include <curl/curl.h>
-char *curl_unescape( const char *url, int length);
+char *curl_unescape(const char *url, int length);
.fi
.SH DESCRIPTION
Obsolete function. Use \fIcurl_easy_unescape(3)\fP instead!
@@ -38,8 +38,8 @@ string" and return that as a new allocated string. All input characters that
are URL encoded (%XX where XX is a two-digit hexadecimal number) will be
converted to their plain text versions.
-If the 'length' argument is set to 0, \fIcurl_unescape(3)\fP will use strlen()
-on the input \fBurl\fP string to find out the size.
+If the \fBlength\fP argument is set to 0, \fIcurl_unescape(3)\fP will use
+strlen() on the input \fBurl\fP string to find out the size.
You must \fIcurl_free(3)\fP the returned string when you are done with it.
.SH EXAMPLE
diff --git a/docs/libcurl/curl_version_info.3 b/docs/libcurl/curl_version_info.3
index 002817253..7755b16a4 100644
--- a/docs/libcurl/curl_version_info.3
+++ b/docs/libcurl/curl_version_info.3
@@ -29,7 +29,7 @@ curl_version_info - returns runtime libcurl version info
.nf
#include <curl/curl.h>
-curl_version_info_data *curl_version_info( CURLversion age);
+curl_version_info_data *curl_version_info(CURLversion age);
.fi
.SH DESCRIPTION
Returns a pointer to a filled in static struct with information about various
diff --git a/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.3 b/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.3
index ab097016e..7e992c6f1 100644
--- a/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.3
+++ b/docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.3
@@ -32,7 +32,7 @@ CURLMOPT_SOCKETFUNCTION \- callback informed about what to wait for
int socket_callback(CURL *easy, /* easy handle */
curl_socket_t s, /* socket */
int what, /* describes the socket */
- void *clientp, /* private callback pointer */
+ void *clientp, /* private callback pointer */
void *socketp); /* private socket pointer */
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_SOCKETFUNCTION, socket_callback);
@@ -87,8 +87,8 @@ All
.nf
static int sock_cb(CURL *e, curl_socket_t s, int what, void *cbp, void *sockp)
{
- GlobalInfo *g = (GlobalInfo*) cbp;
- SockInfo *fdp = (SockInfo*) sockp;
+ GlobalInfo *g = cbp;
+ SockInfo *fdp = sockp;
if(what == CURL_POLL_REMOVE) {
remsock(fdp);