Add API docs to `Machine` methods

2024-01-23 12:50:48 -05:00 · 2024-01-23 12:50:48 -05:00 · 870acc2892
parent 739032762a
commit 870acc2892
1 changed files with 7 additions and 0 deletions
--- 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,