Skip to content

Commit

Permalink
fstream: reformat the doxygen comment of make_file_input_stream()
Browse files Browse the repository at this point in the history
so that the these overloads of `make_file_input_stream()` can have
their accompanied doxygen document.

Signed-off-by: Kefu Chai <[email protected]>
  • Loading branch information
tchaikov committed Jul 3, 2024
1 parent 4c7a802 commit 91defa4
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions include/seastar/core/fstream.hh
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,21 @@ struct file_input_stream_options {
input_stream<char> make_file_input_stream(
file file, uint64_t offset, uint64_t len, file_input_stream_options options = {});

// Create an input_stream for a given file, with the specified options.
// Multiple fibers of execution (continuations) may safely open
// multiple input streams concurrently for the same file.
/// \brief Create an input_stream for a given file, reading starting at a given
/// position of the given file, with the specified options.
/// \param file File to read; multiple streams for the same file may coexist
/// \param offset Starting offset to read from (no alignment restrictions)
///
/// \note Multiple fibers of execution (continuations) may safely open
/// multiple input streams concurrently for the same file.
input_stream<char> make_file_input_stream(
file file, uint64_t offset, file_input_stream_options = {});

// Create an input_stream for reading starting at a given position of the
// given file. Multiple fibers of execution (continuations) may safely open
// multiple input streams concurrently for the same file.
/// Create an input_stream for a given file, with the specified options
/// \param file File to read; multiple streams for the same file may coexist
///
/// \note Multiple fibers of execution (continuations) may safely open
/// multiple input streams concurrently for the same file.
input_stream<char> make_file_input_stream(
file file, file_input_stream_options = {});

Expand Down

0 comments on commit 91defa4

Please sign in to comment.