Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
The Tor Project
Applications
android-components
Commits
c5402d07
Commit
c5402d07
authored
Jun 27, 2019
by
Christian Sadilek
Browse files
Closes #3562: Add missing KDocs fo browser state properties
parent
a5b962a7
Changes
5
Hide whitespace changes
Inline
Side-by-side
components/browser/state/src/main/java/mozilla/components/browser/state/state/BrowserState.kt
View file @
c5402d07
...
...
@@ -8,6 +8,10 @@ import mozilla.components.lib.state.State
/**
* 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
(
val
tabs
:
List
<
TabSessionState
>
=
emptyList
(),
...
...
components/browser/state/src/main/java/mozilla/components/browser/state/state/ContentState.kt
View file @
c5402d07
...
...
@@ -5,7 +5,17 @@
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
(
val
url
:
String
,
...
...
components/browser/state/src/main/java/mozilla/components/browser/state/state/CustomTabSessionState.kt
View file @
c5402d07
...
...
@@ -8,6 +8,9 @@ import java.util.UUID
/**
* 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
(
override
val
id
:
String
=
UUID
.
randomUUID
().
toString
(),
...
...
components/browser/state/src/main/java/mozilla/components/browser/state/state/SessionState.kt
View file @
c5402d07
...
...
@@ -2,6 +2,9 @@ package mozilla.components.browser.state.state
/**
* 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
{
val
id
:
String
...
...
components/browser/state/src/main/java/mozilla/components/browser/state/state/TabSessionState.kt
View file @
c5402d07
...
...
@@ -8,6 +8,9 @@ import java.util.UUID
/**
* 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
(
override
val
id
:
String
=
UUID
.
randomUUID
().
toString
(),
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment