Skip to content

Commit

Permalink
add a doc comment because I'm not a barbarian
Browse files Browse the repository at this point in the history
  • Loading branch information
zadjii-msft committed Jan 13, 2020
1 parent b5c8c85 commit 9aec694
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/buffer/out/textBuffer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1542,6 +1542,16 @@ std::string TextBuffer::GenRTF(const TextAndColor& rows, const int fontHeightPoi
}
}

// Function Description:
// - Reflow the contents from the old buffer into the new buffer. The new buffer
// can have different dimensions than the old buffer. If it does, then this
// function will attempt to maintain the logical contents of the old buffer,
// by continuing wrapped lines onto the next line in the new buffer.
// Arguments:
// - oldBuffer - the text buffer to copy the contents FROM
// - newBuffer - the text buffer to copy the contents TO
// Return Value:
// - S_OK if we successfully copied the contents to the new buffer, otherwise an appropriate HRESULT.
HRESULT TextBuffer::ReflowBuffer(TextBuffer& oldBuffer, TextBuffer& newBuffer)
{
Cursor& oldCursor = oldBuffer.GetCursor();
Expand Down

0 comments on commit 9aec694

Please sign in to comment.