Skip to content

Commit

Permalink
docu
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Flisar authored and Michael Flisar committed Nov 19, 2024
1 parent e4a59e7 commit d0c70b6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
20 changes: 15 additions & 5 deletions documentation/docs/migration/v7.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,20 @@ icon: material/arrow-up-box

Some things have become extension functions to provide target specific implementations and overloads:

* `FileLoggerSetup.<Daily/...>.create` => new import because it is an extension function now:`import com.michaelflisar.lumberjack.loggers.file.create`
* `getAllExistingLogFiles` => new import because it is an extension function now: `import com.michaelflisar.lumberjack.core.getAllExistingLogFiles`
* `Level.priority` => new import because it is an extension function now: `import com.michaelflisar.lumberjack.core.classes.priority`
#### Logger setup classes

I did also fix a typo, namely following:
I do provide platform specific `create` function to make single platform usage easier. On android those do look like following:

* `getLatestLogFiles` => `getLatestLogFile` (also become an extension function btw)
```kotlin
val setup = FileLoggerSetup.Daily.create(context, fileBaseName = "log_daily")
```

In MP projects you can simply use the classes themself if you want to.

#### Functions become extension functions

To provide platform specific implementations, some functions needed to be converted to extension functions:

* `getAllExistingLogFiles` (new import: `import com.michaelflisar.lumberjack.core.getAllExistingLogFiles`)
* `Level.priority` (new import: `import com.michaelflisar.lumberjack.core.classes.priority`)
* `getLatestLogFiles` => `getLatestLogFile` (also fixed a typo)
1 change: 0 additions & 1 deletion documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,5 @@ nav:
- Migration:
- Version 7: migration/v7.md
- More:
- Migration: other-libraries.md
- Other Libraries: other-libraries.md
- About Me: me.md

0 comments on commit d0c70b6

Please sign in to comment.