aboutsummaryrefslogtreecommitdiff
path: root/core/api
AgeCommit message (Collapse)Author
2023-08-31Enable explicit API mode (#3139)Ignat Beresnev
2023-08-14Refactor and document DisplaySourceSet, deprecate ↵Vsevolod Tolstopyatov
SelfRepresentingSingletonSet (#3105) * Deprecate internal API SelfRepresentingSingletonSet for removal as being harmful and unimplement it in DisplaySourceSet * Provide no automatic migration for DisplaySourceSet, as there are no mechanisms for that. Manual migration is the replacement of 'dss' to `setOf(dss)` where applicable * Introduce a convenience-member DefaultRenderer.buildContentNode to avoid wrapping DSS into set manually * Document DisplaySourceSet * Replace Iterable<DisplaySourceSet>.sourceSetIDs with more straightforward Iterable<DisplaySourceSet>.computeSourceSetIds(), refactor all the usages, save some allocations * Start caching CompositeSourceSetID properties to avoid excessive allocations * Update integration tests on the latest revision with Knit version where the workaround is applied Fixes #2897
2023-07-05Decompose Kotlin/Java analysis (#3034)Ignat Beresnev
* Extract analysis into separate modules
2023-07-03Enhance typealias presentation (#3053)Vadim Mishenev
2023-05-17Update KGP to 1.8.20 (#2989)Vadim Mishenev
* Update KGP to 1.8.20 * Update AGP to be compatible with KGP * Replace `AndroidSourceSet` * Dump API * Update integration tests * Update GH actions tests * Refactor Gradle Runner * Fix `TYPE_MISMATCH_WARNING_FOR_INCORRECT_CAPTURE_APPROXIMATION` * Suppress source sets without compilations Dokka suppresses source sets that do no have compilation since such configuration is invalid, it reports a warning or an error * Introduce `dependsOn` for a new `com.android.build.api.dsl.AndroidSourceSet` * API dump * Add comment * Suppress remaining `TYPE_MISMATCH_WARNING_FOR_INCORRECT_CAPTURE_APPROXIMATION` * Add comment --------- Co-authored-by: Ignat Beresnev <ignat.beresnev@jetbrains.com>
2023-03-27Mark utilities.* API as Dokka-internal (#2937)Vsevolod Tolstopyatov
* Deprecate unused declaration, remove inline declaration (as it's binary compatible), opt-in into internal API at project level * Opt-in into DokkaInternalApi where applicable * Get rid of intermediate test-utils module
2023-03-17Introduce InternalDokkaApi annotation (#2904)Vsevolod Tolstopyatov
* Introduce InternalDokkaApi annotation Rationale: dokka-core has a long history of bloating its API shape with utilities that were never intended to be public, and that may expose unwanted implementation details, as well as unwanted compatibility burdens. Eventually, we would like to get rid of them (i.e. by making them internal), but first, it would be nice to provide users with an explicit message about it
2023-02-24Mark Plugin Api as experimental (#2743)Vadim Mishenev
2023-02-24Reorganize tabs for Classlike (#2764)Vadim Mishenev
2023-02-20Add the ability to pretty print DokkaConfiguration (#2872)Ignat Beresnev
2023-01-26Support kotlin wasm targetIgor Yakovlev
2023-01-10Revise documentation (#2728)Ignat Beresnev
Co-authored-by: Sarah Haggarty <sarahhaggarty@users.noreply.github.com>
2022-09-20Update `prism.js` to match new webhelp highlight colors (#2670)Ignat Beresnev
2022-09-02Underline `@param` tag key for more consistency (#2643)Ignat Beresnev
* Underline `@param` tag key for more consistency * Correct keyValue table column ratio
2022-08-18Add deprecation details block (#2622)Ignat Beresnev
2022-08-10Support Var html tag for Javadoc (#2617)Andrey Tyrin
Fixes #2358
2022-08-03Apply the same style to all KDoc tags, including throws/see/parameters (#2587)Ignat Beresnev
2022-07-29Move source links into signature (#2476)Vadim Mishenev
2022-06-30Bump essential dependencies (#2534)Ignat Beresnev
2022-06-19Fix incorrectly labeling java properties as val/var (#2540)Ignat Beresnev
Fixes #2539
2022-06-08Support definitely non-nullable types (#2520)Vadim Mishenev
* Support definitely non-nullable types [Definitely non-nullable types](https://github.com/Kotlin/KEEP/blob/c72601cf35c1e95a541bb4b230edb474a6d1d1a8/proposals/definitely-non-nullable-types.md) are enabled since Kotlin 1.7
2022-05-31Fix gathering inherited properties (#2481)Ignat Beresnev
* Fix gathering inherited properties in PSI * Refacotr KaJ transformer. Change wrapping TagWrapper for getters and setters. * Add logic to merge inherited properties in kotlin from java sources. * Remove getters and setters from JvmField properties for DObject, DEnum, DInterface in KaJ. * Unify InheritedMember DRI logic. * Fix gathering docs obtained from inheriting java sources in descriptors * Apply requested changes. * Resolve rebase conflicts * Use 221 for qodana analysis * Move accessors generation into DefaultDescriptorToDocumentableTranslator * Fix special "is" case for accessors and refactor logic in general * Remove ambiguous import after rebasing * Remove unused imports and format code * Apply review comment suggestions * Preserve previously lost accessor lookalikes * Extract a variable and correct a typo Co-authored-by: Andrzej Ratajczak <andrzej.ratajczak98@gmail.com>
2022-05-16Don't expose enum constructor arguments to documentations (#2497)ebraminio
* Don't expose enum constructor arguments to documentation Enum constructor arguments is mostly internal detail of enums that isn't supposed to be exposed to clients of some library so let's don't put it in the generated documentations result.
2022-05-13Render quotes as blockquotes instead of code blocks. (#2496)TheOnlyTails
2022-04-28Make a default value dependent on source set (#2449)Vadim Mishenev
* Make a default value dependent on source set * Get a default value from an expect source set * Fix default value for expect properties * Deprecate `DefaultValue.value` * Add test * Refactor * Reformat
2022-04-08Rework AnnotationTarget to be stricter (#2414)owengray-google
2022-02-21Add option to merge implicit expect-actual declarations (#2316)Vadim Mishenev
* Add option to merge implicit expect-actual declarations * Merge entries, constructors * Fix StdLib integration test * Add doc
2022-02-17Refactor Ancestry Graphs (#2326)Andrzej Ratajczak
2022-02-17Custom doctag extension (#2343)Ignat Beresnev
* Add an extension point for rendering custom doc tags * Iterate over documentable sourcesets when building custom tags * Extract a nested custom tags brief block into a separate method * Filter out tag content providers and make since kotlin brief a one-liner * Add padding to "Since Kotlin" block in brief description
2022-02-14Shutdown coroutines dispatchers after each module pass (#2325)Ignat Beresnev
* Update kotlinx.coroutines to 1.6.0 * Shutdown common coroutines dispatchers after each module pass * Don't finalize coroutines in unit tests Co-authored-by: Mikhail Zarechenskiy <mikhail.zarechenskiy@jetbrains.com>
2022-01-27KT-50292 - Implement vertical alignment of parameters (#2309)Ignat Beresnev
* Implement vertical alignment (wrapping) of parameters for kt * Add tests for params wrapping and extend matchers to check for classes * Add distinguishable parameters block to kotlinAsJava, extract common logic * Create a separate Kind for symbol function parameters
2022-01-27Fix resolving DRIs of Enum Entries (#2305)Andrzej Ratajczak
* Fix resolving DRIs of Enum Entries * Unify DRIs for Kotlin and Java enums. Add EnumEntry linking tests * Updates EnumEntry extras in documentable translators * Fix tests * Apply requested changes * Apply requested changes
2022-01-12Add global settings to JSON dokka cli input (#2292)Andrzej Ratajczak
* Add global settings to JSON dokka cli input * Apply requested changes * Move initialization of global arguments to extension function in core module
2021-12-23Introduce documentedVisibilities setting (#2270)Ignat Beresnev
* Introduce `documentedVisibilities` setting * Remove hardcoded doc generation for Visibility.PUBLIC, correct tests * Add maven, gradle and cli integration tests for documentedVisibilities * Fix maven plugin configuration overriding the default value * Remove test debug prints * Correct an inconsistency with default values and leave a comment of intentions * Add a test for visibility of private setter
2021-12-06Description list support for JavaDocs (#2213)Ignat Beresnev
2021-11-12Store checked exceptions into `ExtraProperties` (#2222)vmishenev
2021-09-21Fix link to javadoc enum entry (#2131)vmishenev
2021-09-20Improve versioning plugin (#2104)vmishenev
- support for single module projects - version navigator is on all pages - dropdown arrow for version navigator
2021-08-25Manual highlighting webhelp (#2079)vmishenev
* Add manual code highlighting * Fix test * Add kotlinAsJava highlighting * Add runtime highlighting via Prism * Add copy-button for code block * Add tests and refactor * Replace `<br>` for prism.js * Parse trivial default values Co-authored-by: Marcin Aman <marcin.aman@gmail.com>
2021-08-09Property annotation for getter and setter (#2049)vmishenev
2021-07-30Add boolean, nullable types of annotation parameter valuevmishenev
2021-07-23Add numeric types of annotation parameter value (#2035)vmishenev
2021-06-25Cleanup paragraphs and tables in GFM renderer (#1946)Mike Sinkovsky
* GFM renderer: cleanup paragraphs * GFM renderer: cleanup tables * GFM renderer: add tests for wrong header in table Table with extra cell in row is really generated by `all-modules-page` plugin * Remove commented-out lines * Add BriefCommentPreprocessor which inserts a line break between a signature and a brief comment Fixed a bug with `mapTransform` function which replaces table headers with their contents Co-authored-by: Kamil Doległo <kamil.doleglo@interia.pl>
2021-06-22Logging in CLI (#1976)Marcin Aman
2021-05-06Bump compiler to 1.5.0 (#1856)Marcin Aman
* Bump compiler to 1.5.0 * Include Api changes
2021-04-14Introduce binary compatibility plugin (#1774)Marcin Aman
* Introduce binary compatibility plugin * Update diffs