docs: update docs according to the latest changes

Author: mdevils

docs/classes/openapi_client.CommonHttpClientError.md

@@ -4,6 +4,8 @@
 
 [openapi-client](../modules/openapi_client.md).CommonHttpClientError
 
+Error thrown by the common HTTP client.
+
 ## Hierarchy
 
 - `Error`
@@ -49,20 +51,28 @@ Error.constructor
 
 • `Readonly` **options**: `undefined` \| [`CommonHttpClientOptions`](../interfaces/openapi_client.CommonHttpClientOptions.md)
 
+Options of the common HTTP client.
+
 ___
 
 ### request
 
 • `Readonly` **request**: `undefined` \| [`CommonHttpClientFetchRequest`](../interfaces/openapi_client.CommonHttpClientFetchRequest.md)
 
+Request that caused the error. Can be undefined in case of failure during request building phase.
+
 ___
 
 ### response
 
 • `Readonly` **response**: `undefined` \| [`CommonHttpClientFetchResponse`](../interfaces/openapi_client.CommonHttpClientFetchResponse.md)
 
+Response that caused the error. Can be undefined in case of network failure.
+
 ___
 
 ### url
 
 • `Readonly` **url**: `URL`
+
+URL of the request.

docs/interfaces/openapi_client.CommonHttpClientFetchRequestHeaders.md

@@ -4,6 +4,8 @@
 
 [openapi-client](../modules/openapi_client.md).CommonHttpClientFetchRequestHeaders
 
+Request headers as used by the fetch function.
+
 ## Indexable
 
 ▪ [headerName: `string`]: `string`

docs/interfaces/openapi_client.CommonHttpClientOptions.md

@@ -4,6 +4,8 @@
 
 [openapi-client](../modules/openapi_client.md).CommonHttpClientOptions
 
+Options for the common HTTP client.
+
 ## Table of contents
 
 ### Properties
@@ -23,12 +25,16 @@
 
 • **baseUrl**: `string`
 
+Base URL for the API. Endpoints are relative to this URL.
+
 ___
 
 ### binaryResponseType
 
 • **binaryResponseType**: ``"blob"`` \| ``"readableStream"``
 
+Type of the response body for binary responses.
+
 ___
 
 ### errorClass
@@ -39,6 +45,8 @@ ___
 
 • **new errorClass**(`url`, `request`, `response`, `options`, `message`)
 
+Error class to be thrown when an error occurs.
+
 ##### Parameters
 
 | Name | Type |
@@ -59,6 +67,8 @@ ___
 
 ▸ (`url`, `request`): `Promise`\<[`CommonHttpClientFetchResponse`](openapi_client.CommonHttpClientFetchResponse.md)\>
 
+Fetch function. Default is window.fetch-based implementation.
+
 ##### Parameters
 
 | Name | Type |
@@ -80,6 +90,8 @@ ___
 
 ▸ (`response`, `request`): `string`
 
+Format the HTTP error message.
+
 ##### Parameters
 
 | Name | Type |
@@ -97,6 +109,8 @@ ___
 
 • `Optional` **headers**: [`CommonHttpClientRequestHeaders`](openapi_client.CommonHttpClientRequestHeaders.md)
 
+Default headers to be sent with each request.
+
 ___
 
 ### preprocessFetchResponse
@@ -107,6 +121,8 @@ ___
 
 ▸ (`response`, `request`): `Promise`\<[`CommonHttpClientFetchResponse`](openapi_client.CommonHttpClientFetchResponse.md)\>
 
+Preprocess the response before returning it.
+
 ##### Parameters
 
 | Name | Type |
@@ -128,6 +144,8 @@ ___
 
 ▸ (`request`): `Promise`\<[`CommonHttpClientRequest`](../modules/openapi_client.md#commonhttpclientrequest)\>
 
+Preprocess the request before sending it.
+
 ##### Parameters
 
 | Name | Type |

docs/interfaces/openapi_client.CommonHttpClientRequestHeaders.md

@@ -4,6 +4,8 @@
 
 [openapi-client](../modules/openapi_client.md).CommonHttpClientRequestHeaders
 
+A forgiving version of the request headers. Undefined and null values are allowed.
+
 ## Indexable
 
 ▪ [headerName: `string`]: `string` \| `undefined` \| ``null``

docs/interfaces/openapi_client.OpenApiClientGeneratorConfigCore.md

@@ -12,6 +12,7 @@ Configuration for the core classes.
 
 - [cleanupFiles](openapi_client.OpenApiClientGeneratorConfigCore.md#cleanupfiles)
 - [filenameFormat](openapi_client.OpenApiClientGeneratorConfigCore.md#filenameformat)
+- [generateJsDoc](openapi_client.OpenApiClientGeneratorConfigCore.md#generatejsdoc)
 - [relativeDirPath](openapi_client.OpenApiClientGeneratorConfigCore.md#relativedirpath)
 
 ## Properties
@@ -45,6 +46,14 @@ Filename format for the core classes.
 
 ___
 
+### generateJsDoc
+
+• `Optional` **generateJsDoc**: [`GenerateCoreJsDoc`](../modules/openapi_client.md#generatecorejsdoc)
+
+JSDoc generation callback for core classes / members.
+
+___
+
 ### relativeDirPath
 
 • `Optional` **relativeDirPath**: `string`

docs/modules/openapi_client.md

@@ -38,6 +38,7 @@
 - [CommonHttpClientResponseHeaders](openapi_client.md#commonhttpclientresponseheaders)
 - [GenerateClientErrorJsDoc](openapi_client.md#generateclienterrorjsdoc)
 - [GenerateClientJsDoc](openapi_client.md#generateclientjsdoc)
+- [GenerateCoreJsDoc](openapi_client.md#generatecorejsdoc)
 - [GenerateModelJsDoc](openapi_client.md#generatemodeljsdoc)
 - [GenerateModelNameCallback](openapi_client.md#generatemodelnamecallback)
 - [GenerateOperationJsDoc](openapi_client.md#generateoperationjsdoc)
@@ -146,6 +147,42 @@ function generateClientJsDoc({suggestedJsDoc, info}) {
 
 ___
 
+### GenerateCoreJsDoc
+
+Ƭ **GenerateCoreJsDoc**: (`params`: \{ `memberName?`: `string` ; `suggestedJsDoc`: [`JsDocBlock`](../interfaces/index.JsDocBlock.md) ; `typeName`: `string`  }) => [`JsDocBlock`](../interfaces/index.JsDocBlock.md)
+
+#### Type declaration
+
+▸ (`params`): [`JsDocBlock`](../interfaces/index.JsDocBlock.md)
+
+Callback for generating the JSDoc for core classes.
+
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `params` | `Object` | - |
+| `params.memberName?` | `string` | Name of the member of the core class. Empty if the JSDoc is for the class itself. |
+| `params.suggestedJsDoc` | [`JsDocBlock`](../interfaces/index.JsDocBlock.md) | Suggested JSDoc block. Used by default if the callback is not specified. |
+| `params.typeName` | `string` | Name of the core class. |
+
+##### Returns
+
+[`JsDocBlock`](../interfaces/index.JsDocBlock.md)
+
+**`Example`**
+
+```ts
+function GenerateCoreJsDoc({suggestedJsDoc}) {
+        return {
+            ...suggestedJsDoc,
+            tags: [...suggestedJsDoc.tags, {name: 'internal'}]
+        };
+    }
+```
+
+___
+
 ### GenerateModelJsDoc
 
 Ƭ **GenerateModelJsDoc**: (`params`: \{ `fieldPath`: `string`[] ; `schema`: [`OpenApiSchema`](openapi.md#openapischema) ; `schemaName`: `string` ; `suggestedJsDoc`: [`JsDocBlock`](../interfaces/index.JsDocBlock.md)  }) => [`JsDocBlock`](../interfaces/index.JsDocBlock.md)