Skip to content

Commit a3ba8ab

Browse files
committed
[skip-ci][core] Update TDirectoryFile::GetKey() documentation
1 parent aff8c1d commit a3ba8ab

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

io/io/src/TDirectoryFile.cxx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,9 @@ void TDirectoryFile::FillBuffer(char *&buffer)
775775
}
776776

777777
////////////////////////////////////////////////////////////////////////////////
778-
/// Find key with name keyname in the current directory
778+
/// Find key with name `keyname` in the current directory.
779+
/// `keyname` may be of the form name;cycle.
780+
/// See GetKey() for details on the semantics of this form.
779781

780782
TKey *TDirectoryFile::FindKey(const char *keyname) const
781783
{
@@ -787,8 +789,10 @@ TKey *TDirectoryFile::FindKey(const char *keyname) const
787789
}
788790

789791
////////////////////////////////////////////////////////////////////////////////
790-
/// Find key with name keyname in the current directory or
792+
/// Find key with name `keyname` in the current directory or
791793
/// its subdirectories.
794+
/// `keyname` may be of the form name;cycle.
795+
/// See GetKey() for details on the semantics of this form.
792796
///
793797
/// NOTE: that If a key is found, the directory containing the key becomes
794798
/// the current directory
@@ -1130,7 +1134,8 @@ Int_t TDirectoryFile::GetBufferSize() const
11301134

11311135

11321136
////////////////////////////////////////////////////////////////////////////////
1133-
/// Return pointer to key with name,cycle
1137+
/// Return pointer to key with name,cycle. If no key exists with the specified
1138+
/// cycle, returns the key with the highest cycle that is lower than the requested cycle.
11341139
///
11351140
/// if cycle = 9999 returns highest cycle
11361141

0 commit comments

Comments
 (0)