docs(fmt): add missing docstrings

seoklab · Nov 10, 2023 · 8e8fc46 · 8e8fc46
1 parent c6b00f3
commit 8e8fc46
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/include/nuri/fmt/base.h b/include/nuri/fmt/base.h
@@ -52,8 +52,20 @@ class MoleculeStream {
     return true;
   }
 
+  /**
+   * @brief Get the current molecule.
+   * @return Reference to the current molecule.
+   * @pre Previous call to advance() must return true, otherwise the behavior
+   *      is unspecified.
+   */
   Molecule &current() { return mol_; }
 
+  /**
+   * @brief Get the current molecule.
+   * @return Const reference to the current molecule.
+   * @pre Previous call to advance() must return true, otherwise the behavior
+   *      is unspecified.
+   */
   const Molecule &current() const { return mol_; }
 
 private: