From 91d03cd6f26fca2dde71a3ecdb2a239cf7bf76c0 Mon Sep 17 00:00:00 2001 From: Mikael Simberg Date: Tue, 26 Sep 2023 17:27:28 +0200 Subject: [PATCH] Add documentation for Pipeline::sub_pipeline --- include/dlaf/common/pipeline.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/dlaf/common/pipeline.h b/include/dlaf/common/pipeline.h index 7d6afa64bb..c213f7092f 100644 --- a/include/dlaf/common/pipeline.h +++ b/include/dlaf/common/pipeline.h @@ -66,8 +66,10 @@ class Pipeline { return pipeline->read(); } - // TODO: Documentation. - // TODO: Name? + /// Create a sub pipeline to the value contained in the current Pipeline + /// + /// All accesses to the sub pipeline are sequenced after previous accesses and before later accesses to + /// the original pipeline, independently of when values are accessed in the sub pipeline. Pipeline sub_pipeline() { namespace ex = pika::execution::experimental;