From 04bc13929f791061adf323c5998a4094ec47a0c6 Mon Sep 17 00:00:00 2001
From: Philip Rebohle <philip.rebohle@tu-dortmund.de>
Date: Thu, 28 Jun 2018 01:18:16 +0200
Subject: [PATCH] [hud] Added some missing documentation

---
 src/dxvk/hud/dxvk_hud.h | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/src/dxvk/hud/dxvk_hud.h b/src/dxvk/hud/dxvk_hud.h
index cb2609454..4feccca1b 100644
--- a/src/dxvk/hud/dxvk_hud.h
+++ b/src/dxvk/hud/dxvk_hud.h
@@ -36,8 +36,21 @@ namespace dxvk::hud {
     
     ~Hud();
     
+    /**
+     * \brief Update HUD
+     * 
+     * Updates the data to display.
+     * Should be called once per frame.
+     */
     void update();
 
+    /**
+     * \brief Render HUD
+     * 
+     * Renders the HUD to the given context.
+     * \param [in] ctx Device context
+     * \param [in] surfaceSize Image size, in pixels
+     */
     void render(
       const Rc<DxvkContext>& ctx,
             VkExtent2D       surfaceSize);
@@ -73,7 +86,7 @@ namespace dxvk::hud {
 
     void renderHudElements(
       const Rc<DxvkContext>&  ctx);
-      
+
     void updateUniformBuffer(
       const Rc<DxvkContext>&  ctx,
       const HudUniformData&   data);