Docs don't show up if they are inherited from the classpath [202177236]

Bug

Status Update

No update yet.

Description

jb...@google.com

created issue #1

Oct 5, 2021 06:37PM

Dackka already supports inheritance in the same package (here is the test https://cs.android.com/androidx/platform/tools/dokka-devsite-plugin/+/master:src/test/java/com/google/devsite/renderer/converters/ClasslikeDocumentableConverterTest.kt;l=672) but it would be nice if it support inheritance across packages as well.

For example, we have a case in FragmentActivity where it inherits onMultiWindowModeChanged from Activity, but it is inherited through both androidx.activity.ComponentActivity and androidx.core.app.ComponentActivity, neither of which actually override onMultiWindowModeChanged.

I would expect the documentation on onMultiWindowModeChanged in FragmentActivity here to include the documentation on the same method in Activity here

Comments

ow...@google.com <ow...@google.com> #2Oct 15, 2021 06:59PM

Hi,

Thank you for taking the time to improve libphonenumber!

We are looking into this and will respond as soon as possible.

ow...@google.com <ow...@google.com> #3Dec 22, 2021 07:18PM

Hi,

Thanks much for raising this issue. This is one of our known issue, which is not documented. Having phone numbers of this long are very rare. libphonenumber cannot do anything better here.

Reasons:

JavaScript Number type has limitation of 2^53 (9007199254740992) as the max literal it can hold. When provided more than that like "90018408059449376"(17 digit), JS starts rounding the value. Unfortunately this is within the range of possible phone number length i.e 17 digit.
Both the alternatives leads to backward-incompatible changes as the type of the field '''national_number''' has to be changed; thus leading to client-side compile issue . Eg: setNationalNumber(1234) / conversions to payloads like JSON.

Marking the field as [jstype = JS_STRING]
Or using new JS data type BigInt.

We will update FAQ at GitHub stating some of these points. Maybe you can compare with Number.MAX_VALUE and avoid such cases. Or post request to a Java/CPP/PY libphonenumber clients, as these langs have much more matured data type systems.

ow...@google.com <ow...@google.com> #4Jan 6, 2022 10:13PM

Added to client FAQ as known issue. https://github.com/google/libphonenumber/pull/2674

as...@google.com <as...@google.com> #5Feb 22, 2022 02:41PM

Assigned to ow...@google.com.

+923146233552

ap...@google.com <ap...@google.com> #6May 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

na...@google.com <na...@google.com> Aug 17, 2022 08:15PM

Reassigned to fs...@google.com.

fs...@google.com <fs...@google.com> #7Aug 18, 2022 02:13PM

Marked as fixed.

I believe that this is a duplicate of b/170124934 and has been fixed. owengray@google.com let me know if that is not correct and I should re-open.

ow...@google.com <ow...@google.com> #8Aug 19, 2022 11:24AM

Status: Assigned (reopened)

I don't believe it is either.
The externalDocumentablesProvider can pull in API, but the (e.g. Platform) source jar does not contain documentation, and so even if we could inherit documentation via the externalDocumentablesProvider, I don't believe it would work.

I think addressing this FR would require:

Getting a version of the platform source jar that contains documentation.
making sure that the externaldocumentableconverter parses documentation.
setting up a system to inherit external documentation via the external documentable system. (would probably require an upstream PR).

I don't believe this worked in doclava or old dokka, so I'm classifying it as an FR.

as...@google.com <as...@google.com> Sep 6, 2022 05:25PM

Status: New