-
Notifications
You must be signed in to change notification settings - Fork 408
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
GFM: Properties inheritance #1548
Labels
Comments
And second issue - wrote here as #1386 was closed - seems that #1442 should to be reverted, because it is both:
|
Still broken in 1.4.32, here is my diff for files generatd by Dokka 0.9.17 and Dokka 1.4.32
# Button
-`class Button : `[`Control`](../-control/README.md)`<`[`uiButton`](../../libui/ui-button.md)`>`
+`class `[`Button`](README.md)`(text: String) : `[`Control`](../-control/README.md)`<uiButton> `
+
+Wrapper class for uiButton - a simple button.
-Wrapper class for [uiButton](../../libui/ui-button.md) - a simple button.
### Constructors
-| Name | Summary |
+| | |
|---|---|
-| [Button](-button.md) | `Button(text: String)`<br>Wrapper class for [uiButton](../../libui/ui-button.md) - a simple button. |
+| [Button](-button.md) | `fun `[`Button`](-button.md)`(text: String)` |
### Properties
| Name | Summary |
|---|---|
-| [text](text.md) | `var text: String`<br>The static text of the button. |
+| [text](text.md) | `var `[`text`](text.md)`: String`<br>The static text of the button. |
### Inherited properties
| Name | Summary |
|---|---|
+| [disposed](README.md#-1156166768%2FProperties%2F123127132) | `val `[`disposed`](README.md#-1156166768%2FProperties%2F123127132)`: Boolean`<br>Returns `true` if object was disposed - in this case [dispose](../-disposable/dispose.md) will do nothing, all other operations are invalid and will `throw Error("Resource is disposed")`. |
-| [enabled](../-control/enabled.md) | `var enabled: Boolean`<br>Whether the Control should be enabled or disabled. Defaults to `true`. |
+| [enabled](README.md#-1213503932%2FProperties%2F123127132) | `var `[`enabled`](README.md#-1213503932%2FProperties%2F123127132)`: Boolean`<br>Whether the Control should be enabled or disabled. |
-| [parent](../-control/parent.md) | `var parent: `[`Control`](../-control/README.md)`<*>?`<br>Returns parent of the control or `null` for detached. |
+| [parent](README.md#-2075457877%2FProperties%2F123127132) | `var `[`parent`](README.md#-2075457877%2FProperties%2F123127132)`: `[`Control`](../-control/README.md)`<*>?`<br>Returns parent of the control or `null` for detached. |
-| [toplevel](../-control/toplevel.md) | `val toplevel: Boolean`<br>Returns whether the control is a top level one or not. |
+| [toplevel](README.md#-865778266%2FProperties%2F123127132) | `val `[`toplevel`](README.md#-865778266%2FProperties%2F123127132)`: Boolean`<br>Returns whether the control is a top level one or not. |
-| [visible](../-control/visible.md) | `var visible: Boolean`<br>Whether the Control should be visible or hidden. Defaults to `true`. |
+| [visible](README.md#-1299346893%2FProperties%2F123127132) | `var `[`visible`](README.md#-1299346893%2FProperties%2F123127132)`: Boolean`<br>Whether the Control should be visible or hidden. |
### Functions
| Name | Summary |
|---|---|
-| [action](action.md) | `fun action(block: `[`Button`](README.md)`.() -> Unit): Unit`<br>Function to be run when the user clicks the Button. Only one function can be registered at a time. |
+| [action](action.md) | `fun `[`action`](action.md)`(block: `[`Button`](README.md)`.() -> Unit)`<br>Function to be run when the user clicks the Button. |
### Inherited functions
| Name | Summary |
|---|---|
-| [disable](../-control/disable.md) | `fun disable(): Unit`<br>Disables the Control. |
+| [disable](../-control/disable.md) | `fun `[`disable`](../-control/disable.md)`()`<br>Disables the Control. |
-| [dispose](../-control/dispose.md) | `open fun dispose(): Unit`<br>Dispose and free all allocated resources. |
+| [dispose](../-control/dispose.md) | `open override fun `[`dispose`](../-control/dispose.md)`()`<br>Dispose and free all allocated resources. |
-| [enable](../-control/enable.md) | `fun enable(): Unit`<br>Enables the Control. |
+| [enable](../-control/enable.md) | `fun `[`enable`](../-control/enable.md)`()`<br>Enables the Control. |
-| [getHandle](../-control/get-handle.md) | `fun getHandle(): ULong`<br>Returns the OS-level handle associated with this Control. |
+| [getHandle](../-control/get-handle.md) | `fun `[`getHandle`](../-control/get-handle.md)`(): ULong`<br>Returns the OS-level handle associated with this Control. |
-| [hide](../-control/hide.md) | `fun hide(): Unit`<br>Hides the Control. Hidden controls do not participate in layout (that is, Box, GridPane, etc. does not reserve space for hidden controls). |
+| [hide](../-control/hide.md) | `fun `[`hide`](../-control/hide.md)`()`<br>Hides the Control. |
-| [isEnabled](../-control/is-enabled.md) | `fun isEnabled(): Boolean`<br>Whether the Control is enabled. |
+| [isEnabled](../-control/is-enabled.md) | `fun `[`isEnabled`](../-control/is-enabled.md)`(): Boolean`<br>Whether the Control is enabled. |
-| [isEnabledToUser](../-control/is-enabled-to-user.md) | `fun isEnabledToUser(): Boolean`<br>Whether the Control and all parents are enabled. |
+| [isEnabledToUser](../-control/is-enabled-to-user.md) | `fun `[`isEnabledToUser`](../-control/is-enabled-to-user.md)`(): Boolean`<br>Whether the Control and all parents are enabled. |
-| [isVisible](../-control/is-visible.md) | `fun isVisible(): Boolean`<br>Whether the Control is visible. |
+| [isVisible](../-control/is-visible.md) | `fun `[`isVisible`](../-control/is-visible.md)`(): Boolean`<br>Whether the Control is visible. |
-| [show](../-control/show.md) | `fun show(): Unit`<br>Shows the Control. |
+| [show](../-control/show.md) | `fun `[`show`](../-control/show.md)`()`<br>Shows the Control. |
+ |
msink
changed the title
[1-4-20-dev-10] Properties inheritance
[1-4-32] Properties inheritance
May 8, 2021
IgnatBeresnev
added
the
format: gfm
An issue/PR related to Dokka's GFM output format
label
Mar 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
Functions inheritance works (almost) correctly, but properties handled differently and wrong.
Say we have class hierarhy (simplified a little):
In 1.4.20-dev-10
Button
overview translates to:Functions
fun [action](action.md)(block: [Button](README.md).() -> Unit)
fun [disable](../-control/disable.md)()
open override fun [dispose](../-control/dispose.md)()
fun [enable](../-control/enable.md)()
open operator fun [equals](../../libui.ktx.draw/-attributed-string/README.md#kotlin%2FAny%2Fequals%2F%23kotlin.Any%3F%2FPointingToDeclaration%2F)(other: Any?): Boolean
open fun [hashCode](../../libui.ktx.draw/-attributed-string/README.md#kotlin%2FAny%2FhashCode%2F%23%2FPointingToDeclaration%2F)(): Int
fun [hide](../-control/hide.md)()<br>Hides the Control.
fun [isEnabled](../-control/is-enabled.md)(): Boolean
fun [isEnabledToUser](../-control/is-enabled-to-user.md)(): Boolean
fun [isVisible](../-control/is-visible.md)(): Boolean
fun [show](../-control/show.md)()
open fun [toString](../../libui.ktx.draw/-attributed-string/README.md#kotlin%2FAny%2FtoString%2F%23%2FPointingToDeclaration%2F)(): String
Properties
val [disposed](disposed.md): Boolean
var [enabled](enabled.md): Boolean
var [parent](parent.md): [Control](../-control/README.md)?
var [text](text.md): String
val [toplevel](toplevel.md): Boolean
var [visible](visible.md): Boolean
Expected behaviour
(1) - should not be here at all (already reported in #1523)
(2) - should refer to
../-disposable/
(3) - should refer to
../-control/
The text was updated successfully, but these errors were encountered: