Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the ability to pretty print DokkaConfiguration #2872

Merged
merged 3 commits into from
Feb 20, 2023

Conversation

IgnatBeresnev
Copy link
Member

@IgnatBeresnev IgnatBeresnev commented Feb 16, 2023

This is a prerequisite / enabler for #2873

  • Extracted JSON and configuration related utility functions into a separate file for readability
  • Added internal API for json pretty print + tests
  • Added new public API to pretty print DokkaConfiguration and ConfigurationBlock.
  • Deprecated the old API in favour of the new with a drop-in replacement.
  • Changed deprecated usages within the project

Comment on lines -7 to -11
public static final fun GlobalDokkaConfiguration (Ljava/lang/String;)Lorg/jetbrains/dokka/GlobalDokkaConfiguration;
public static final fun apply (Lorg/jetbrains/dokka/DokkaConfiguration;Lorg/jetbrains/dokka/GlobalDokkaConfiguration;)Lorg/jetbrains/dokka/DokkaConfiguration;
public static final fun build (Ljava/lang/Iterable;)Ljava/util/List;
public static final fun toJsonString (Lorg/jetbrains/dokka/DokkaConfiguration;)Ljava/lang/String;
public static final fun toJsonString (Lorg/jetbrains/dokka/plugability/ConfigurableBlock;)Ljava/lang/String;
Copy link
Member Author

@IgnatBeresnev IgnatBeresnev Feb 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The functions have been moved to another file, but within the same package, so source compatibility should be preserved

@IgnatBeresnev IgnatBeresnev merged commit fa22175 into master Feb 20, 2023
@IgnatBeresnev IgnatBeresnev deleted the add-pretty-json-print branch February 20, 2023 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants