add comments

microsoft · Jan 15, 2025 · eaf237d · eaf237d
1 parent c89e331
commit eaf237d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/include/mscclpp/env.hpp b/include/mscclpp/env.hpp
@@ -11,8 +11,12 @@ namespace mscclpp {
 
 class Env;
 
+/// Get the MSCCL++ environment.
+/// @return A reference to the global environment object.
 std::shared_ptr<Env> env();
 
+/// The MSCCL++ environment. The constructor reads environment variables and sets the corresponding fields.
+/// Use the @ref env() function to get the environment object.
 class Env {
  public:
   const std::string debug;