Skip to content

Commit 8341e13

Browse files
committed
[ntuple] Document RPageInfoExtended
1 parent f77b79c commit 8341e13

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

tree/ntuple/v7/inc/ROOT/RNTupleDescriptor.hxx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,16 @@ public:
346346
void SetHasChecksum(bool hasChecksum) { fHasChecksum = hasChecksum; }
347347
};
348348

349+
// clang-format off
350+
/**
351+
\class ROOT::RClusterDescriptor::RPageInfoExtended
352+
\ingroup NTuple
353+
\brief Additional information about a page in an in-memory RPageRange.
354+
355+
Used by RPageRange::Find() to return information relative to the RPageRange. This information is not stored on disk
356+
and we don't need to keep it in memory because it can be easily recomputed.
357+
*/
358+
// clang-format on
349359
struct RPageInfoExtended : RPageInfo {
350360
private:
351361
/// Index (in cluster) of the first element in page.

0 commit comments

Comments
 (0)