Fill in some documentation. (#116)

1 files changed, 10 insertions, 0 deletions

diff --git a/include/amber/amber.h b/include/amber/amber.h
index 343a564..a20fce7 100644
--- a/include/amber/amber.h
+++ b/include/amber/amber.h
@@ -22,21 +22,31 @@
 namespace amber {
 
 enum class EngineType : uint8_t {
+  /// Use the Vulkan backend, if available
   kVulkan = 0,
+  /// Use the Dawn backend, if available
   kDawn,
 };
 
 struct Options {
+  /// Sets the engine to be created. Default Vulkan.
   EngineType engine = EngineType::kVulkan;
+  /// Holds the device for the given engine. If the device is a |nullptr|
+  /// a device will be created. If a |default_device| is provided it must
+  /// outlive the Amber instance and clean is the callers responsibility.
   void* default_device = nullptr;
+  /// Set true to only parse the given script, does not execute the engine.
   bool parse_only = false;
 };
 
+/// Main interface to the Amber environment.
 class Amber {
  public:
   Amber();
   ~Amber();
 
+  /// Executes the given |data| script with the provided |opts|. Returns a
+  /// |Result| which indicates if the execution succeded.
   amber::Result Execute(const std::string& data, const Options& opts);
 };