docs(newtypes): add a pointer to the algorithm API functions

See the discussion in #250.
open-quantum-safe · Oct 23, 2023 · a5dd060 · a5dd060
1 parent c71cb42
commit a5dd060
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/oqs/src/macros.rs b/oqs/src/macros.rs
@@ -6,6 +6,8 @@ macro_rules! newtype_buffer {
     ($name: ident, $name_ref: ident) => {
         /// New owned buffer
         ///
+        /// Construct the reference version of this type through the algorithm API functions.
+        ///
         /// Optional support for `serde` if that feature is enabled.
         #[derive(Debug, Clone, PartialEq, Eq)]
         #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]