debian-packages/dyaml
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Doc fixes.

Browse source
This commit is contained in:
Ferdinand Majerech 2014-07-30 23:30:37 +02:00
parent 5da8561df4
commit 4d6634f49b
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
source/dyaml/reader.d
View file

@ -47,10 +47,8 @@ class ReaderException : YAMLException
} }
} }
/// Lazily reads and decodes data from a buffer, only storing as much as needed at any /// Provides an API to read characters from a UTF-8 buffer and build slices into that
/// moment. /// buffer to avoid allocations (see SliceBuilder).
///
/// Adds a '\0' to the end of the data.
final class Reader final class Reader
{ {
private: private:
@ -132,9 +130,10 @@ final class Reader
/// Get character at specified index relative to current position. /// Get character at specified index relative to current position.
/// ///
/// Params: index = Index of the character to get relative to current position /// Params: index = Index of the character to get relative to current position
/// in the buffer. /// in the buffer. Can point outside of the buffer; In that
/// case, '\0' will be returned.
/// ///
/// Returns: Character at specified position. /// Returns: Character at specified position or '\0' if outside of the buffer.
/// ///
// XXX removed; search for 'risky' to find why. // XXX removed; search for 'risky' to find why.
// Throws: ReaderException if trying to read past the end of the buffer. // Throws: ReaderException if trying to read past the end of the buffer.