Added some documentation

tmayoff · Nov 24, 2024 · f908ad6 · f908ad6
1 parent 6da1eaa
commit f908ad6
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/wren/include/wren/graph.hpp b/wren/include/wren/graph.hpp
@@ -39,8 +39,14 @@ class GraphBuilder {
  public:
   explicit GraphBuilder(const std::shared_ptr<Context> &ctx) : ctx_(ctx) {}
 
+  /**
+    @brief This calls compile() and then assigns the graph to the renderer
+  */
   [[nodiscard]] auto build() const -> expected<void>;
 
+  /**
+    @brief Compiles the builder into an actual graph, it creates missing resources for targets and binds targets to the swapchain
+  */
   [[nodiscard]] auto compile() const -> expected<Graph>;
 
   auto add_pass(const std::string &name, const PassResources &resources,