Commit c5402d07 authored by Christian Sadilek's avatar Christian Sadilek
Browse files

Closes #3562: Add missing KDocs fo browser state properties

parent a5b962a7
...@@ -8,6 +8,10 @@ import mozilla.components.lib.state.State ...@@ -8,6 +8,10 @@ import mozilla.components.lib.state.State
/** /**
* Value type that represents the complete state of the browser/engine. * Value type that represents the complete state of the browser/engine.
*
* @property tabs the list of open tabs, defaults to an empty list.
* @property selectedTabId the ID of the currently selected (active) tab.
* @property customTabs the list of custom tabs, defaults to an empty list.
*/ */
data class BrowserState( data class BrowserState(
val tabs: List<TabSessionState> = emptyList(), val tabs: List<TabSessionState> = emptyList(),
......
...@@ -5,7 +5,17 @@ ...@@ -5,7 +5,17 @@
package mozilla.components.browser.state.state package mozilla.components.browser.state.state
/** /**
* Value type that represents the state of the content displayed in a [SessionState]. * Value type that represents the state of the content within a [SessionState].
*
* @property url the loading or loaded URL.
* @property private whether or not the session is private.
* @property title the title of the current page.
* @property progress the loading progress of the current page.
* @property searchTerms the last used search terms, or an empty string if no
* search was executed for this session.
* @property securityInfo the security information as [SecurityInfoState],
* describing whether or not the current session is for a secure URL, as well
* as the host and SSL certificate authority.
*/ */
data class ContentState( data class ContentState(
val url: String, val url: String,
......
...@@ -8,6 +8,9 @@ import java.util.UUID ...@@ -8,6 +8,9 @@ import java.util.UUID
/** /**
* Value type that represents the state of a Custom Tab. * Value type that represents the state of a Custom Tab.
*
* @property id the ID of this custom tab and session.
* @property content the [ContentState] of this custom tab.
*/ */
data class CustomTabSessionState( data class CustomTabSessionState(
override val id: String = UUID.randomUUID().toString(), override val id: String = UUID.randomUUID().toString(),
......
...@@ -2,6 +2,9 @@ package mozilla.components.browser.state.state ...@@ -2,6 +2,9 @@ package mozilla.components.browser.state.state
/** /**
* Interface for states that contain a [ContentState] and can be accessed via an [id]. * Interface for states that contain a [ContentState] and can be accessed via an [id].
*
* @property id the unique id of the session.
* @property content the [ContentState] of this session.
*/ */
interface SessionState { interface SessionState {
val id: String val id: String
......
...@@ -8,6 +8,9 @@ import java.util.UUID ...@@ -8,6 +8,9 @@ import java.util.UUID
/** /**
* Value type that represents the state of a tab (private or normal). * Value type that represents the state of a tab (private or normal).
*
* @property id the ID of this tab and session.
* @property content the [ContentState] of this tab.
*/ */
data class TabSessionState( data class TabSessionState(
override val id: String = UUID.randomUUID().toString(), override val id: String = UUID.randomUUID().toString(),
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment