Fixes documentation lint errors

This commit is contained in:
ericdecanini 2022-08-19 14:33:10 +02:00
parent 88fc0afea5
commit 1bd46e902b
3 changed files with 7 additions and 7 deletions

View File

@ -53,7 +53,7 @@ interface SpaceStateHandler : DefaultLifecycleObserver {
)
/**
* Gets the Space ID of the space on top of the backstack
* Gets the Space ID of the space on top of the backstack.
*
* May return null to indicate the All Chats space
*/

View File

@ -1128,10 +1128,10 @@ class VectorPreferences @Inject constructor(
}
/**
* Sets the space backstack that is used for up navigation
* This needs to be persisted because navigating up through spaces should work across sessions
* Sets the space backstack that is used for up navigation.
* This needs to be persisted because navigating up through spaces should work across sessions.
*
* Only the IDs of the spaces are stored
* Only the IDs of the spaces are stored.
*/
fun setSpaceBackstack(spaceBackstack: List<String?>) {
val spaceIdsJoined = spaceBackstack.takeIf { it.isNotEmpty() }?.joinToString(",")
@ -1139,7 +1139,7 @@ class VectorPreferences @Inject constructor(
}
/**
* Gets the space backstack used for up navigation
* Gets the space backstack used for up navigation.
*/
fun getSpaceBackstack(): List<String?> {
val spaceIdsJoined = defaultPrefs.getString(SETTINGS_PERSISTED_SPACE_BACKSTACK, null)

View File

@ -48,8 +48,8 @@ internal class DefaultNavigatorTest {
)
/**
* The below tests are by no means all that we want to test in [DefaultNavigator]
* Please add relevant tests as you make changes to or related to other functions in the class
* The below tests are by no means all that we want to test in [DefaultNavigator].
* Please add relevant tests as you make changes to or related to other functions in the class.
*/
@Test