Hierarchy doesn't show up if parent classes are not part of the same package [170124934]

Fixed

Bug

Status Update

No update yet.

Description

ti...@google.com

created issue #1

Oct 5, 2020 05:37PM

Expected:

https://developer.android.com/reference/kotlin/androidx/paging/PagedList

Actual:

https://android.devsite.corp.google.com/reference/kotlin/androidx/paging/PagedList?db=androidx-refdocs

Comments

ti...@google.com <ti...@google.com> #2Oct 5, 2020 06:32PM

https://screenshot.googleplex.com/4jFaRDfVc9qPo4G

as...@google.com <as...@google.com> #3Oct 7, 2020 02:24PM

Impacts Enums as well (probably all ClassLikes)

as...@google.com <as...@google.com> #4Oct 12, 2020 06:19PM

ti...@google.com <ti...@google.com> Nov 11, 2020 07:55PM

Accepted by ti...@google.com.

ti...@google.com <ti...@google.com> Nov 13, 2020 07:19PM

Status: New

ti...@google.com <ti...@google.com> #5Jan 22, 2021 07:38PM

Still outstanding

sa...@google.com <sa...@google.com> Feb 16, 2021 06:13PM

Accepted by sa...@google.com.

sa...@google.com <sa...@google.com> #6Feb 16, 2021 09:24PM

I'm suspecting that this isn't about the same package, and is about whether the type hierarchy goes external

See this comment in Subclasses.kt:

// TODO Support external types
// type.dri is not found in classlikes if it isn't from this package (or invocation?)
// external types like stdlib appear in the supertypes but we filter them out by forcing
// the use of classlikes here. This could just be DRI based and we'd connect the external
// packages to the proper base URL.

Does that sound right?

sa...@google.com <sa...@google.com> #7Feb 17, 2021 03:54PM

Assigned to sa...@google.com.

So there are ways to get the _first_ external supertype to show up in the hierarchy, but if we want to follow the supertype hierarchy up through multiple external classes, I think we have to bring in those class definitions somehow. I don't currently understand enough about how this worked in classic dokka to figure out how we could replicate that in the new plugin, but hoping to learn more.

ti...@google.com <ti...@google.com> Feb 19, 2021 07:07PM

Status: New

ti...@google.com <ti...@google.com> #8May 13, 2021 09:56PM

Lowering to P2 per discussion with the Paging team during a Kotlin refdoc review today.

ow...@google.com <ow...@google.com> #9Jun 1, 2021 05:34PM

We are also seeing this in e.g. Navigation, where LazyNavArgs implements the builtin type Lazy.

ap...@google.com <ap...@google.com> #10Jun 7, 2021 01:14PM

Project: platform/tools/dokka-devsite-plugin
Branch: master

commit cd69d0553183d39f7ffb9fb3c4e9fe2321769408
Author: Owen Gray <owengray@google.com>
Date: Wed Jun 02 14:17:00 2021

Add tests; link issues to bugs

Test: several new tests
Bug: 170124934
Change-Id: Ib738335aa2529269b89a2d5c89bbbfda4efd2a8c

M src/main/java/com/google/devsite/renderer/impl/ClassGraph.kt
M src/test/java/com/google/devsite/renderer/converters/ClasslikeDocumentableConverterTest.kt

https://android-review.googlesource.com/1724811

https://goto.google.com/android-sha1/cd69d0553183d39f7ffb9fb3c4e9fe2321769408

as...@google.com <as...@google.com> Sep 20, 2021 02:08PM

Assigned to as...@google.com.

as...@google.com <as...@google.com> #11Oct 26, 2021 04:17PM

Status: New

Blocked by upstream dokka issues

https://github.com/Kotlin/dokka/issues/1692 and

https://github.com/Kotlin/dokka/issues/1227

ow...@google.com <ow...@google.com> #12Dec 22, 2021 05:39PM

The general case for this may not be feasible.

I think what we want specifically is the ability to get the android stubs jar (e.g. prebuilts/fullsdk-darwin/platforms/android-31/android.jar) added to the class graph, like the Java standard library is.
(We may need to make sure that we currently can get the java standard library into the classgraph, so we can show an inheritance hierarchy like PagedList > AbstractList > List,Collection,Iterable,Object and show inherited functions. (This is kind of blocked by a bug that has PagedList thinking it inherits from Kotlin.collections.List))

ow...@google.com <ow...@google.com> #13May 9, 2022 02:54PM

Jetbrains recently landed the upstream Virtus-written code that should allow us to do this: PR 2307. The tests and source there should be useful.

After creating the ExternalDocumentableProvider plugin in DevsitePlugin.kt we should be able to use something like provider.findClasslike( DRI ) to pull a DClasslike from the Android/JDK/Kotlin jar on the classpath.
This should allow us to populate the Inherits From hierarchy and ideally cross-package inherited documentation (e.g. from Android.app.Activity) (b/202177236). The DocumentablesGraph in ClassGraph.kt is a Map<DRI, Documentable>. We may be able to fall back to the external resolver via a default get value or something.

ap...@google.com <ap...@google.com> #14May 24, 2022 03:02PM

Project: platform/tools/dokka-devsite-plugin
Branch: master

commit e470a7610c916cc9519ff25b7d5e9be3a822f561
Author: Fred Sladkey <fsladkey@google.com>
Date: Fri May 13 13:38:23 2022

Add external documentables provider extension point and use it when computing classlike heirarchy

Bug: 170124934
Bug: 202177236

Change-Id: Ia956343e329d4841a000ac50ad19ff6f253db083

M testData/compose/docs/reference/androidx/compose/foundation/interaction/DragInteraction.Stop.html
M testData/compose/docs/reference/androidx/compose/animation/core/SpringSpec.html
M testData/paging/docs/reference/androidx/paging/PagingDataAdapter.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/VectorizedSnapSpec.html
M testData/innerClasses/docs/reference/dokkatest/inner/OuterClass.InnerEnum.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/SpringSpec.html
M testData/paging/docs/reference/androidx/paging/LoadStateAdapter.html
M testData/compose/docs/reference/androidx/compose/foundation/interaction/PressInteraction.Cancel.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/ProduceStateScope.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/gestures/GestureCancellationException.html
M testData/fragment/docs/reference/kotlin/androidx/fragment/app/Fragment.html
M testData/compose/docs/reference/androidx/compose/runtime/MonotonicFrameClock.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/DragInteraction.Stop.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/snapshots/SnapshotApplyConflictException.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/MutatePriority.html
M testData/paging/docs/reference/kotlin/androidx/paging/LoadStateAdapter.html
M testData/restrictTo/docs/reference/kotlin/androidx/annotation/RestrictTo.Scope.html
M testData/compose/docs/reference/androidx/compose/animation/core/FloatSpringSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/PressInteraction.Cancel.html
M testData/fragment/docs/reference/androidx/fragment/app/FragmentTabHost.html
M testData/compose/docs/reference/androidx/compose/foundation/MutatePriority.html
M testData/compose/docs/reference/androidx/compose/animation/core/VectorizedSnapSpec.html
M testData/paging/docs/reference/kotlin/androidx/paging/PagingDataAdapter.html
M testData/fragment/docs/reference/androidx/fragment/app/DialogFragment.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/DragInteraction.Cancel.html
M src/main/java/com/google/devsite/renderer/impl/DocumentablesHolder.kt
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/InfiniteAnimationPolicy.Key.html
M testData/compose/docs/reference/androidx/compose/foundation/interaction/FocusInteraction.Focus.html
M testData/compose/docs/reference/androidx/compose/runtime/snapshots/SnapshotStateList.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/PressInteraction.Press.html
M testData/compose/docs/reference/androidx/compose/runtime/snapshots/SnapshotApplyConflictException.html
M testData/compose/docs/reference/androidx/compose/foundation/interaction/FocusInteraction.Unfocus.html
M testData/fragment/docs/reference/kotlin/androidx/fragment/app/Fragment.SavedState.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/KeyframesSpec.html
M testData/compose/docs/reference/androidx/compose/foundation/gestures/Orientation.html
M testData/compose/docs/reference/androidx/compose/animation/core/InfiniteAnimationPolicy.html
M testData/fragment/docs/reference/kotlin/androidx/fragment/app/Fragment.InstantiationException.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/Recomposer.State.html
M testData/compose/docs/reference/androidx/compose/animation/EnterExitState.html
M testData/paging/docs/reference/kotlin/androidx/paging/TerminalSeparatorType.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/InfiniteAnimationPolicy.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/VectorizedTweenSpec.html
M testData/paging/docs/reference/androidx/paging/LoadType.html
M src/main/java/com/google/devsite/DevsitePlugin.kt
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/layout/IntrinsicSize.html
M testData/paging/docs/reference/androidx/paging/PagedList.html
M testData/compose/docs/reference/androidx/compose/foundation/interaction/PressInteraction.Press.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/FocusInteraction.Focus.html
M testData/fragment/docs/reference/kotlin/androidx/fragment/app/FragmentTabHost.html
M testData/compose/docs/reference/androidx/compose/animation/core/VectorizedTweenSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/VectorizedRepeatableSpec.html
M testData/paging/docs/reference/kotlin/androidx/paging/PagedList.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/VectorizedSpringSpec.html
M testData/compose/docs/reference/androidx/compose/foundation/shape/CornerBasedShape.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/MonotonicFrameClock.Key.html
M testData/compose/docs/reference/androidx/compose/material/DismissDirection.html
M testData/compose/docs/reference/androidx/compose/foundation/shape/GenericShape.html
M testData/compose/docs/reference/androidx/compose/material/BottomSheetValue.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/VectorizedDurationBasedAnimationSpec.html
M testData/compose/docs/reference/androidx/compose/animation/core/VectorizedSpringSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/TweenSpec.html
M testData/compose/docs/reference/androidx/compose/animation/core/KeyframesSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/gestures/Orientation.html
M testData/fragment/docs/reference/androidx/fragment/app/Fragment.html
M testData/fragment/docs/reference/androidx/fragment/app/FragmentActivity.html
M testData/compose/docs/reference/androidx/compose/animation/core/RepeatMode.html
M testData/simple/docs/reference/dokkatest/simple/Three.html
M testData/compose/docs/reference/androidx/compose/foundation/gestures/GestureCancellationException.html
M testData/innerClasses/docs/reference/dokkatest/inner/OuterClass.Leaf.html
M testData/compose/docs/reference/androidx/compose/material/ModalBottomSheetValue.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/DragInteraction.Start.html
M testData/innerClasses/docs/reference/kotlin/dokkatest/inner/OuterClass.Leaf.html
M testData/compose/docs/reference/androidx/compose/runtime/collection/MutableVector.html
M testData/compose/docs/reference/androidx/compose/runtime/ProduceStateScope.html
M testData/compose/docs/reference/androidx/compose/animation/core/VectorizedFloatAnimationSpec.html
M testData/compose/docs/reference/androidx/compose/animation/core/VectorizedRepeatableSpec.html
M testData/compose/docs/reference/androidx/compose/runtime/Recomposer.State.html
M src/main/java/com/google/devsite/renderer/impl/ClassGraph.kt
M testData/compose/docs/reference/androidx/compose/animation/core/FloatTweenSpec.html
M testData/compose/docs/reference/androidx/compose/animation/core/RepeatableSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/RepeatableSpec.html
M testData/compose/docs/reference/androidx/compose/animation/core/VectorizedKeyframesSpec.html
M testData/compose/docs/reference/androidx/compose/runtime/snapshots/SnapshotStateMap.html
M testData/compose/docs/reference/androidx/compose/material/SnackbarDuration.html
M testData/compose/docs/reference/androidx/compose/animation/core/DurationBasedAnimationSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/DurationBasedAnimationSpec.html
M testData/compose/docs/reference/androidx/compose/animation/core/AnimationEndReason.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/DismissValue.html
M testData/compose/docs/reference/androidx/compose/foundation/gestures/PressGestureScope.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/FocusInteraction.Unfocus.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/FloatTweenSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/MonotonicFrameClock.html
M testData/compose/docs/reference/androidx/compose/animation/core/SnapSpec.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/FloatSpringSpec.html
M testData/fragment/docs/reference/kotlin/androidx/fragment/app/FragmentActivity.html
M src/test/java/com/google/devsite/testing/ConverterTestBase.kt
M testData/paging/docs/reference/androidx/paging/PagedListAdapter.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/gestures/PressGestureScope.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/SnackbarResult.html
M testData/paging/docs/reference/androidx/paging/ItemSnapshotList.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/collection/MutableVector.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/snapshots/SnapshotStateList.html
M testData/compose/docs/reference/androidx/compose/foundation/interaction/DragInteraction.Start.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/BottomSheetValue.html
M testData/compose/docs/reference/androidx/compose/runtime/snapshots/SnapshotMutableState.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/DrawerValue.html
M testData/linking/docs/reference/dokkatest/linking/KotlinEnum.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/SnapSpec.html
M testData/compose/docs/reference/androidx/compose/material/BackdropValue.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/AnimationEndReason.html
M testData/paging/docs/reference/androidx/paging/TerminalSeparatorType.html
M testData/fragment/docs/reference/kotlin/androidx/fragment/app/FragmentContainerView.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/SnackbarDuration.html
M testData/paging/docs/reference/kotlin/androidx/paging/ItemSnapshotList.html
M testData/paging/docs/reference/androidx/paging/RemoteMediator.InitializeAction.html
M testData/paging/docs/reference/kotlin/androidx/paging/PagedListAdapter.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/DismissDirection.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/EnterExitState.html
M testData/compose/docs/reference/androidx/compose/animation/core/TweenSpec.html
M testData/compose/docs/reference/androidx/compose/material/SnackbarResult.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/BottomDrawerValue.html
M testData/compose/docs/reference/androidx/compose/material/DismissValue.html
M testData/innerClasses/docs/reference/kotlin/dokkatest/inner/OuterClass.InnerEnum.html
M src/main/java/com/google/devsite/renderer/MultiLanguageRenderer.kt
M src/test/java/com/google/devsite/renderer/converters/ClasslikeDocumentableConverterTest.kt
M testData/compose/docs/reference/androidx/compose/foundation/interaction/DragInteraction.Cancel.html
M testData/fragment/docs/reference/androidx/fragment/app/Fragment.InstantiationException.html
M testData/compose/docs/reference/androidx/compose/foundation/layout/IntrinsicSize.html
M testData/compose/docs/reference/androidx/compose/animation/core/VectorizedDurationBasedAnimationSpec.html
M testData/linking/docs/reference/kotlin/dokkatest/linking/KotlinEnum.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/snapshots/SnapshotMutableState.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/RepeatMode.html
M testData/compose/docs/reference/androidx/compose/animation/core/InfiniteAnimationPolicy.Key.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/BackdropValue.html
M src/main/java/com/google/devsite/renderer/converters/ClasslikeDocumentableConverter.kt
M testData/paging/docs/reference/kotlin/androidx/paging/LoadType.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/VectorizedKeyframesSpec.html
M testData/fragment/docs/reference/androidx/fragment/app/Fragment.SavedState.html
M testData/restrictTo/docs/reference/androidx/annotation/RestrictTo.Scope.html
M testData/compose/docs/reference/kotlin/androidx/compose/runtime/snapshots/SnapshotStateMap.html
M testData/paging/docs/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/shape/GenericShape.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/shape/CornerBasedShape.html
M testData/compose/docs/reference/androidx/compose/foundation/interaction/PressInteraction.Release.html
M testData/fragment/docs/reference/kotlin/androidx/fragment/app/DialogFragment.html
M testData/compose/docs/reference/kotlin/androidx/compose/foundation/interaction/PressInteraction.Release.html
M testData/simple/docs/reference/kotlin/dokkatest/simple/Three.html
M testData/compose/docs/reference/androidx/compose/material/DrawerValue.html
M testData/compose/docs/reference/androidx/compose/material/BottomDrawerValue.html
M testData/compose/docs/reference/kotlin/androidx/compose/material/ModalBottomSheetValue.html
M testData/compose/docs/reference/androidx/compose/runtime/MonotonicFrameClock.Key.html
M testData/fragment/docs/reference/androidx/fragment/app/FragmentContainerView.html
M testData/compose/docs/reference/kotlin/androidx/compose/animation/core/VectorizedFloatAnimationSpec.html

https://android-review.googlesource.com/2097500

as...@google.com <as...@google.com> May 31, 2022 02:11PM

Assigned to fs...@google.com.

fs...@google.com <fs...@google.com> Jun 7, 2022 01:47PM

Marked as fixed.

Issue 170124934

Description

Issue summary

Comments

ti...@google.com <ti...@google.com> #2Oct 5, 2020 06:32PM

as...@google.com <as...@google.com> #3Oct 7, 2020 02:24PM

as...@google.com <as...@google.com> #4Oct 12, 2020 06:19PM

ti...@google.com <ti...@google.com> Nov 11, 2020 07:55PM

ti...@google.com <ti...@google.com> Nov 13, 2020 07:19PM

ti...@google.com <ti...@google.com> #5Jan 22, 2021 07:38PM

sa...@google.com <sa...@google.com> Feb 16, 2021 06:13PM

sa...@google.com <sa...@google.com> #6Feb 16, 2021 09:24PM

sa...@google.com <sa...@google.com> #7Feb 17, 2021 03:54PM

ti...@google.com <ti...@google.com> Feb 19, 2021 07:07PM

ti...@google.com <ti...@google.com> #8May 13, 2021 09:56PM

ow...@google.com <ow...@google.com> #9Jun 1, 2021 05:34PM

ap...@google.com <ap...@google.com> #10Jun 7, 2021 01:14PM

as...@google.com <as...@google.com> Sep 20, 2021 02:08PM

as...@google.com <as...@google.com> #11Oct 26, 2021 04:17PM

ow...@google.com <ow...@google.com> #12Dec 22, 2021 05:39PM

ow...@google.com <ow...@google.com> #13May 9, 2022 02:54PM

ap...@google.com <ap...@google.com> #14May 24, 2022 03:02PM

as...@google.com <as...@google.com> May 31, 2022 02:11PM

fs...@google.com <fs...@google.com> Jun 7, 2022 01:47PM

Add comment

Issue metadata