Make some comments in profiles.hh doxygen-enabled

These are proper documentation of the API, so they deserve to be here

1 files changed, 18 insertions, 8 deletions

diff --git a/src/libstore/profiles.hh b/src/libstore/profiles.hh
index 9d5d4779c..3cadd5c2a 100644
--- a/src/libstore/profiles.hh
+++ b/src/libstore/profiles.hh
@@ -68,22 +68,32 @@ void lockProfile(PathLocks & lock, const Path & profile);
    rebuilt. */
 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();
 
-/* 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();
 
-/* 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();
 
-/* 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();
 
-/* 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
-   exist */
+/**
+ * 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 exist
+ */
 Path getDefaultProfile();
 
 }