Skip to content

Commit eb20944

Browse files
committed
Polish documentation
Signed-off-by: Dmitry Sulman <[email protected]>
1 parent ed22cb3 commit eb20944

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ A Java/Kotlin library that integrates Logback Access with Reactor Netty HTTP ser
1111

1212
**Reactor Netty HTTP Server** is a non-blocking, asynchronous server built on the Netty networking framework and used as the default runtime for handling HTTP requests in Spring WebFlux. It enables reactive, event-driven processing of web requests, making it well-suited for scalable and high-throughput applications. In Spring Boot, it's automatically configured when building reactive applications with the `spring-boot-starter-webflux` dependency.
1313

14-
**Logback Access** is a module of the Logback logging framework that provides HTTP access logging capabilities, similar to those in servlet containers like Tomcat or Jetty. It allows logging of incoming HTTP requests and responses using customizable patterns and supports easy configuration through an XML file.
14+
**Logback Access** is a module of the Logback logging library that provides HTTP access logging capabilities for servlet containers like Tomcat or Jetty. It allows logging of incoming HTTP requests and responses using customizable patterns and supports easy configuration through an XML file.
1515

16-
**Logback Access for Reactor Netty** library serves as a bridge between the Reactor Netty HTTP logging mechanism and the Logback Access library. It enables detailed HTTP access logging with configurable formats, filters, and appenders through Logback Access configuration.
16+
**Logback Access for Reactor Netty** library serves as a bridge between the Reactor Netty HTTP logging mechanism and the Logback Access library. It enables detailed HTTP access logging with configurable formats, filters, and appenders through Logback Access XML configuration.
1717

1818
## Features
1919

logback-access-reactor-netty/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/Extensions.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import java.net.URL
77
* Extension for [HttpServer] providing [HttpServer.accessLog] method alternative.
88
*
99
* @param reactorNettyAccessLogFactory The [ReactorNettyAccessLogFactory] instance for access log configuration.
10-
* @return a new [HttpServer]
10+
* @return a new [HttpServer].
1111
*/
1212
fun HttpServer.enableLogbackAccess(reactorNettyAccessLogFactory: ReactorNettyAccessLogFactory): HttpServer =
1313
accessLog(true, reactorNettyAccessLogFactory)
@@ -16,7 +16,7 @@ fun HttpServer.enableLogbackAccess(reactorNettyAccessLogFactory: ReactorNettyAcc
1616
* Extension for [HttpServer] providing [HttpServer.accessLog] method alternative with a default
1717
* [ReactorNettyAccessLogFactory] configuration.
1818
*
19-
* @return a new [HttpServer]
19+
* @return a new [HttpServer].
2020
*/
2121
fun HttpServer.enableLogbackAccess(): HttpServer = enableLogbackAccess(ReactorNettyAccessLogFactory())
2222

logback-access-reactor-netty/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/ReactorNettyAccessLogFactory.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,8 @@ class ReactorNettyAccessLogFactory : AccessLogFactory {
200200
/**
201201
* Applies the provided [AccessLogArgProvider] to create a new [AccessLog] instance.
202202
*
203-
* @param argProvider the provider of arguments to building an [AccessLog] instance
204-
* @return a new [AccessLog] instance
203+
* @param argProvider the provider of arguments to building an [AccessLog] instance.
204+
* @return a new [AccessLog] instance.
205205
*/
206206
override fun apply(argProvider: AccessLogArgProvider) = AccessLog(accessContext, argProvider)
207207

0 commit comments

Comments
 (0)