From f8448e3c97884dcb2b7783af0b771b78eb70e6d4 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Mon, 12 Feb 2024 21:28:15 +0100 Subject: [PATCH] [partition] Clarify documentation of static functions --- src/modules/partition/PartitionViewStep.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/modules/partition/PartitionViewStep.cpp b/src/modules/partition/PartitionViewStep.cpp index 0fabe26e1..4d93ce060 100644 --- a/src/modules/partition/PartitionViewStep.cpp +++ b/src/modules/partition/PartitionViewStep.cpp @@ -129,7 +129,8 @@ jobDescriptions( const Calamares::JobList& jobs ) /** @brief A top-level description of what @p choice does * - * Returns a (branded) string describing what @p choice will do. + * Returns a translated string describing what @p choice will do. + * Includes branding information. */ static QString modeDescription( Config::InstallChoice choice ) @@ -157,7 +158,7 @@ modeDescription( Config::InstallChoice choice ) /** @brief A top-level description of what @p choice does to disk @p info * - * Returns a (branded, and device-specific) string describing what + * Returns a translated string, with branding and device information, describing what * will be done to device @p info when @p choice is made. The @p listLength * is used to provide context; when more than one disk is in use, the description * works differently.