Skip to content

Commit 1cbd33d

Browse files
committed
[ntuple] Add RNTupleProcessor::Create docstring
1 parent bb86981 commit 1cbd33d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,14 @@ public:
271271
RIterator begin() { return RIterator(*this, 0); }
272272
RIterator end() { return RIterator(*this, ROOT::kInvalidNTupleIndex); }
273273

274+
/////////////////////////////////////////////////////////////////////////////
275+
/// \brief Create an `RNTupleProcessor` for a single RNTuple.
276+
///
277+
/// \param[in] ntuple The name and storage location of the RNTuple to process.
278+
/// \param[in] model An RNTupleModel specifying which fields can be read by the processor. If no model is provided,
279+
/// one will be created based on the descriptor of the first ntuple specified.
280+
///
281+
/// \return A pointer to the newly created RNTupleProcessor.
274282
static std::unique_ptr<RNTupleProcessor>
275283
Create(const RNTupleOpenSpec &ntuple, std::unique_ptr<RNTupleModel> model = nullptr);
276284

0 commit comments

Comments
 (0)