Update documentation

bitwarden · Apr 9, 2024 · 8d0507f · 8d0507f
1 parent b3a44d4
commit 8d0507f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/...com/x8bit/bitwarden/authenticator/ui/authenticator/feature/edititem/EditItemNavigation.kt b/...com/x8bit/bitwarden/authenticator/ui/authenticator/feature/edititem/EditItemNavigation.kt
@@ -15,7 +15,7 @@ private const val EDIT_ITEM_ROUTE = "$EDIT_ITEM_PREFIX/{$EDIT_ITEM_ITEM_ID}"
 /**
  * Class to retrieve authenticator item arguments from the [SavedStateHandle].
  *
- * @property itemId ID of the item to be retrieved.
+ * @property itemId ID of the item to be edited.
  */
 data class EditItemArgs(val itemId: String) {
     constructor(savedStateHandle: SavedStateHandle) : this(
@@ -24,7 +24,7 @@ data class EditItemArgs(val itemId: String) {
 }
 
 /**
- * Add the item screen to the nav graph.
+ * Add the edit item screen to the nav graph.
  */
 fun NavGraphBuilder.editItemDestination(
     onNavigateBack: () -> Unit = { },
@@ -42,7 +42,7 @@ fun NavGraphBuilder.editItemDestination(
 }
 
 /**
- * Navigate to the item screen.
+ * Navigate to the edit item screen.
  */
 fun NavController.navigateToEditItem(
     itemId: String,

diff --git a/...lin/com/x8bit/bitwarden/authenticator/ui/authenticator/feature/edititem/EditItemScreen.kt b/...lin/com/x8bit/bitwarden/authenticator/ui/authenticator/feature/edititem/EditItemScreen.kt
@@ -66,7 +66,7 @@ import com.x8bit.bitwarden.authenticator.ui.platform.theme.DEFAULT_STAY_TRANSITI
 import kotlinx.collections.immutable.toImmutableList
 
 /**
- * Displays the authenticator item screen.
+ * Displays the edit authenticator item screen.
  */
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable

diff --git a/.../com/x8bit/bitwarden/authenticator/ui/authenticator/feature/edititem/EditItemViewModel.kt b/.../com/x8bit/bitwarden/authenticator/ui/authenticator/feature/edititem/EditItemViewModel.kt
@@ -28,7 +28,7 @@ import javax.inject.Inject
 private const val KEY_STATE = "state"
 
 /**
- * View model responsible for handling user interaction with the authenticator item screen.
+ * View model responsible for handling user interaction with the edit authenticator item screen.
  */
 @HiltViewModel
 class EditItemViewModel @Inject constructor(
@@ -329,7 +329,7 @@ class EditItemViewModel @Inject constructor(
 }
 
 /**
- * Represents the state for displaying an item in the authenticator.
+ * Represents the state for displaying an editable item in the authenticator.
  *
  * @property itemId ID of the item displayed.
  * @property viewState Current state of the [EditItemScreen].
@@ -397,7 +397,7 @@ data class EditItemState(
 }
 
 /**
- * Represents a set of events related to viewing an authenticator item.
+ * Represents a set of events related to editing an authenticator item.
  */
 sealed class EditItemEvent {
 
@@ -413,7 +413,7 @@ sealed class EditItemEvent {
 }
 
 /**
- * Represents a set of actions related to viewing an authenticator item.
+ * Represents a set of actions related to editing an authenticator item.
  * Each subclass of this sealed class denotes a distinct action that can be taken.
  */
 sealed class EditItemAction {