From 6d6064cebf077598c35d0852a7f9ade1c196f1a1 Mon Sep 17 00:00:00 2001 From: Tyler Dauwalder Date: Wed, 3 Dec 2003 08:58:49 +0000 Subject: [PATCH] Added doxygen for new methods. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@5552 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- src/apps/bin/makeudfimage/OutputFile.cpp | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/apps/bin/makeudfimage/OutputFile.cpp b/src/apps/bin/makeudfimage/OutputFile.cpp index 1dd143e132..ae7505a55c 100644 --- a/src/apps/bin/makeudfimage/OutputFile.cpp +++ b/src/apps/bin/makeudfimage/OutputFile.cpp @@ -32,6 +32,11 @@ OutputFile::WriteAt(off_t pos, const void *buffer, size_t size) return BFile::WriteAt(pos, buffer, size); } +/*! \brief Writes \a size bytes worth of data from \a data at the current + position in the file, incrementing the file's position marker as it goes. + + \param bufferSize The size of the memory buffer to be used for writing. +*/ ssize_t OutputFile::Write(BDataIO &data, size_t size, size_t bufferSize) { @@ -68,6 +73,11 @@ OutputFile::Write(BDataIO &data, size_t size, size_t bufferSize) return error ? ssize_t(error) : ssize_t(bytes); } +/*! \brief Writes \a size bytes worth of data from \a data at position + \a pos in the file without incrementing the file's position marker. + + \param bufferSize The size of the memory buffer to be used for writing. +*/ ssize_t OutputFile::WriteAt(off_t pos, BDataIO &data, size_t size, size_t bufferSize) { @@ -105,6 +115,11 @@ OutputFile::WriteAt(off_t pos, BDataIO &data, size_t size, size_t bufferSize) return error ? ssize_t(error) : ssize_t(bytes); } +/*! \brief Writes \a size bytes worth of zeros at the current position + in the file, incrementing the file's position marker as it goes. + + \param bufferSize The size of the memory buffer to be used for writing. +*/ ssize_t OutputFile::Zero(size_t size, size_t bufferSize) { @@ -135,6 +150,11 @@ OutputFile::Zero(size_t size, size_t bufferSize) return error ? ssize_t(error) : ssize_t(bytes); } +/*! \brief Writes \a size bytes worth of zeros at position \a pos + in the file without incrementing the file's position marker. + + \param bufferSize The size of the memory buffer to be used for writing. +*/ ssize_t OutputFile::ZeroAt(off_t pos, size_t size, size_t bufferSize) {