Skip to content

Commit

Permalink
Fix javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
vitalijr2 committed Feb 13, 2025
1 parent 981cf3a commit 0aff1a6
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 2 deletions.
43 changes: 43 additions & 0 deletions elf4j/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Mock loggers for elf4j

[SLF4J][slf4j] provider with mock loggers backed by [Mockito][].

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "mockito" Warning

Missing link or image reference definition: "mockito"

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "slf4j" Warning

Missing link or image reference definition: "slf4j"

> [!WARNING]
> This library does not support _parallel test execution_.
[![Java Version][java-version]][jdk-download]

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "java-version" Warning

Missing link or image reference definition: "java-version"

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "jdk-download" Warning

Missing link or image reference definition: "jdk-download"
![elf4j Version][elf4j-version]

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "elf4j-version" Warning

Missing link or image reference definition: "elf4j-version"
![Mockito Version][mockito-version]

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "mockito-version" Warning

Missing link or image reference definition: "mockito-version"
![Maven Central Last Update][maven-central-last-update]

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "maven-central-last-update" Warning

Missing link or image reference definition: "maven-central-last-update"
[![Maven Central][maven-central]][maven-central-link]

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "maven-central-link" Warning

Missing link or image reference definition: "maven-central-link"

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "maven-central" Warning

Missing link or image reference definition: "maven-central"
[![Javadoc][javadoc]][javadoc-link]

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "javadoc" Warning

Missing link or image reference definition: "javadoc"

Check warning

Code scanning / Markdownlint (reported by Codacy)

Missing link or image reference definition: "javadoc-link" Warning

Missing link or image reference definition: "javadoc-link"

## Table of Contents

<!--ts-->

## How to use

Just put a test dependency to your POM:

```xml
<dependency>
<artifactId>mock-loggers-elf4j</artifactId>
<groupId>io.github.vitalijr2.logging</groupId>
<scope>test</scope>
<version>1.1.1</version>
</dependency>
```

The simplest usage example looks like this:

```java
@Test
void helloWorld() {
var helloService = new HelloService();

assertDoesNotThrow(helloService::sayHelloWorld);

verify(Logger.instance()).atInfo().log("Hello World!");
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
*
* assertDoesNotThrow(helloService::sayHelloWorld);
*
* verify(LoggerFactory.getLogger("HelloService")).log(Level.INFO, "Hello World!");
* verify(Logger.instance()).atInfo().log("Hello World!");
* }
* </code></pre>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
*
* assertDoesNotThrow(helloService::sayHelloWorld);
*
* verify(Logger.instance()).atInfo().log("Hello World!");
* verify(LoggerFactory.getLogger("HelloService")).log(Level.INFO, "Hello World!");
* }
* </code></pre>
*
Expand Down

0 comments on commit 0aff1a6

Please sign in to comment.