puck/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

Make some comments in profiles.hh doxygen-enabled

Browse source 
These are proper documentation of the API, so they deserve to be here
This commit is contained in:
Théophane Hufschmitt 2023-03-27 10:02:10 +02:00
parent 717e81df13
commit 128994509f
1 changed files with 18 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/libstore/profiles.hh
View file

@ -68,22 +68,32 @@ void lockProfile(PathLocks & lock, const Path & profile);
rebuilt. */ rebuilt. */
std::string optimisticLockProfile(const Path & profile); std::string optimisticLockProfile(const Path & profile);
/* Creates and returns the path to a directory suitable for storing the user’s /**
profiles. */ * Create and return the path to a directory suitable for storing the user’s
* profiles.
*/
Path profilesDir(); Path profilesDir();
/* Returns the path to the profile directory for root (but doesn't try creating it) */ /**
* Return the path to the profile directory for root (but don't try creating it)
*/
Path rootProfilesDir(); Path rootProfilesDir();
/* Creates and returns the path to the file used for storing the users's channels */ /**
* Create and return the path to the file used for storing the users's channels
*/
Path defaultChannelsDir(); Path defaultChannelsDir();
/* Returns the path to the channel directory for root (but doesn't try creating it) */ /**
* Return the path to the channel directory for root (but don't try creating it)
*/
Path rootChannelsDir(); Path rootChannelsDir();
/* Resolve the default profile (~/.nix-profile by default, $XDG_STATE_HOME/ /**
nix/profile if XDG Base Directory Support is enabled), and create if doesn't * Resolve the default profile (~/.nix-profile by default,
exist */ * $XDG_STATE_HOME/nix/profile if XDG Base Directory Support is enabled),
* and create if doesn't exist
*/
Path getDefaultProfile(); Path getDefaultProfile();
} }