napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[partition] Clarify documentation of static functions

Browse Source
This commit is contained in:
Adriaan de Groot 2024-02-12 21:28:15 +01:00
parent bb53d0cd5d
commit f8448e3c97
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/modules/partition/PartitionViewStep.cpp
View File

@ -129,7 +129,8 @@ jobDescriptions( const Calamares::JobList& jobs )
/** @brief A top-level description of what @p choice does /** @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 static QString
modeDescription( Config::InstallChoice choice ) 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 /** @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 * 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 * is used to provide context; when more than one disk is in use, the description
* works differently. * works differently.