From 870acc2892661d1d2c9f9f39c43d79cb4bbaacb0 Mon Sep 17 00:00:00 2001
From: John Ericson <John.Ericson@Obsidian.Systems>
Date: Tue, 23 Jan 2024 12:50:48 -0500
Subject: [PATCH] Add API docs to `Machine` methods

---
 src/libstore/machines.hh | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/libstore/machines.hh b/src/libstore/machines.hh
index d25fdf1b3..7dd812cf0 100644
--- a/src/libstore/machines.hh
+++ b/src/libstore/machines.hh
@@ -19,8 +19,15 @@ struct Machine {
     const std::string sshPublicHostKey;
     bool enabled = true;
 
+    /**
+     * @return Whether `features` is a subset of the union of `supportedFeatures` and
+     * `mandatoryFeatures`
+     */
     bool allSupported(const std::set<std::string> & features) const;
 
+    /**
+     * @return @Whether `mandatoryFeatures` is a subset of `features`
+     */
     bool mandatoryMet(const std::set<std::string> & features) const;
 
     Machine(decltype(storeUri) storeUri,