Skip to content

Commit 9b5627e

Browse files
committed
Add documentation to Joran classes
Signed-off-by: Dmitry Sulman <[email protected]>
1 parent f76cc78 commit 9b5627e

File tree

4 files changed

+24
-1
lines changed

4 files changed

+24
-1
lines changed

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/LogbackAccessSpringProfileAction.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ import org.xml.sax.Attributes
99
* Logback Access [BaseModelAction] for `<springProfile>` tags. Allows a section of a
1010
* Logback Access configuration to only be enabled when a specific profile is active.
1111
*
12-
* @see [org.springframework.boot.logging.logback.SpringProfileAction]
12+
* See [SpringProfileAction](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/SpringProfileAction.java).
13+
*
1314
* @see [LogbackAccessSpringProfileModel]
1415
* @see [LogbackAccessSpringProfileModelHandler]
1516
*/

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/LogbackAccessSpringProfileModel.kt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,12 @@ package io.github.dmitrysulman.logback.access.reactor.netty.joran
22

33
import ch.qos.logback.core.model.NamedModel
44

5+
/**
6+
* Logback Access [NamedModel] to support `<springProfile>` tags.
7+
*
8+
* See [SpringProfileModel](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/SpringProfileModel.java).
9+
*
10+
* @see [LogbackAccessSpringProfileAction]
11+
* @see [LogbackAccessSpringProfileModelHandler]
12+
*/
513
class LogbackAccessSpringProfileModel : NamedModel()

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/LogbackAccessSpringProfileModelHandler.kt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ import ch.qos.logback.core.model.processor.ModelInterpretationContext
77
import ch.qos.logback.core.util.OptionHelper
88
import org.springframework.core.env.Environment
99

10+
/**
11+
* Logback Access [ModelHandlerBase] model handler to support `<springProfile>` tags.
12+
*
13+
* See [SpringProfileModelHandler](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/SpringProfileModelHandler.java).
14+
*
15+
* @see [LogbackAccessSpringProfileModel]
16+
* @see [LogbackAccessSpringProfileAction]
17+
*/
1018
class LogbackAccessSpringProfileModelHandler(
1119
context: Context,
1220
private val environment: Environment,

logback-access-reactor-netty-spring-boot-starter/src/main/kotlin/io/github/dmitrysulman/logback/access/reactor/netty/joran/ReactorNettyJoranConfigurator.kt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ import ch.qos.logback.core.model.processor.DefaultProcessor
88
import org.springframework.core.env.Environment
99
import java.util.function.Supplier
1010

11+
/**
12+
* Extended version of the Logback Access [JoranConfigurator] that adds support of `<springProfile>` tags.
13+
*
14+
* See [SpringBootJoranConfigurator](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/SpringBootJoranConfigurator.java).
15+
*
16+
*/
1117
class ReactorNettyJoranConfigurator(
1218
private val environment: Environment,
1319
) : JoranConfigurator() {

0 commit comments

Comments
 (0)