Add KDocs for DokkaLogger API #3265
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IgnatBeresnev
changed the title
whyoleg
approved these changes
Nov 10, 2023
| * Dokka's `progress` maps to: | ||
| * | ||
| * * CLI - shown by default | ||
| * * Gradle - `info` |
There was a problem hiding this comment.
What is the reason to have different levels for Gradle vs Maven here?
vmishenev
approved these changes
Nov 20, 2023
| * - Transforming pages | ||
| * | ||
| * These can be shown by default if there is no other way to track progress (like Gradle's progress bar), | ||
| * and should be at the same level or one of the debug levels otherwise. |
There was a problem hiding this comment.
What is about Dokka's LoggingLevel? progress < debug?
| * * Dokka is performing: $generationName | ||
| * | ||
| * Dokka's `warn` maps to: | ||
| * * CLI - `warn` |
There was a problem hiding this comment.
What does warn mean for the console? Is shown by default? What logging levels do we have for the console?
| @@ -10,10 +10,99 @@ public interface DokkaLogger { | |||
| public var warningsCount: Int | |||
| public var errorsCount: Int | |||
|
|
|||
| /** | |||
| * This level is for showing significant execution steps. | |||
There was a problem hiding this comment.
Should they be understandable for users?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have added comments to the logging interface to explicitly explain new requirements for logging.