Digital PCT265 story MVAPCT-272: Clean up comments.

This commit is contained in:
Hedden, Kyle Matthew 2024-10-22 14:43:36 -04:00
parent 868b18e66d
commit 4d73de398f

View File

@ -17,19 +17,19 @@ public protocol MoleculeListProtocol {
/// Asks the delegate to add molecules in relation to another molecule. This is the preferred method for relativity.
func addMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], position: AddMoleculesPosition, molecule: (ListItemModelProtocol & MoleculeModelProtocol), animation: UITableView.RowAnimation?)
/** Asks the delegate to remove molecules. Never ask to remove a molecule at an index.
/** Asks the delegate to remove any molecule at a particular index. Never ask to remove a specific molecule via it's index.
Note: Avoid doing this to prevent accidental deletion mid transition. Prefer the declarative approach of deleting a paricular molecule with removeMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol].
Note: Avoid doing this when possible to prevent accidental deletion mid transition. Prefer the declarative approach of deleting a paricular molecule with removeMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol].
*/
func removeMolecules(at indexPaths: [IndexPath], animation: UITableView.RowAnimation?)
/// Asks the delegate to remove particular molecules from the list.
/// Asks the delegate to remove the specified molecules from the list.
func removeMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], animation: UITableView.RowAnimation?)
/// Asks the delegate to swap batches of molecules.
/// Asks the delegate to swap batches of molecules in relation to a particular index.
func swapMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], with replacements: [ListItemModelProtocol & MoleculeModelProtocol], at indexPath: IndexPath, animation: UITableView.RowAnimation?)
/// Asks the delegate to swap batches of molecules.
/// Asks the delegate to swap batches of molecules in relation to a particular molecule.
func swapMolecules(_ molecules: [ListItemModelProtocol & MoleculeModelProtocol], with replacements: [ListItemModelProtocol & MoleculeModelProtocol], position: AddMoleculesPosition, molecule: (ListItemModelProtocol & MoleculeModelProtocol)?, animation: UITableView.RowAnimation?)
}