Documentation++

This commit is contained in:
Teo Mrnjavac 2017-03-01 13:34:48 +01:00
parent ebeb4e4ab2
commit 6c7cdb5f50
6 changed files with 150 additions and 6 deletions

View file

@ -29,12 +29,37 @@ class Partition;
namespace PartUtils
{
/**
* @brief canBeReplaced checks whether the given Partition satisfies the criteria
* for replacing it with the new OS.
* @param candidate the candidate partition to replace.
* @return true if the criteria are met, otherwise false.
*/
bool canBeReplaced( Partition* candidate );
/**
* @brief canBeReplaced checks whether the given Partition satisfies the criteria
* for resizing (shrinking) it to make room for a new OS.
* @param candidate the candidate partition to resize.
* @return true if the criteria are met, otherwise false.
*/
bool canBeResized( Partition* candidate );
/**
* @brief canBeReplaced checks whether the given Partition satisfies the criteria
* for resizing (shrinking) it to make room for a new OS.
* @param core the PartitionCoreModule instance.
* @param partitionPath the device path of the candidate partition to resize.
* @return true if the criteria are met, otherwise false.
*/
bool canBeResized( PartitionCoreModule* core, const QString& partitionPath );
/**
* @brief runOsprober executes os-prober, parses the output and writes relevant
* data to GlobalStorage.
* @param core the PartitionCoreModule instance.
* @return a list of os-prober entries, parsed.
*/
OsproberEntryList runOsprober( PartitionCoreModule* core );
}