diff options
| author | cmiller@zippy.cornsilk.net <> | 2007-10-11 13:29:09 -0400 |
|---|---|---|
| committer | cmiller@zippy.cornsilk.net <> | 2007-10-11 13:29:09 -0400 |
| commit | 91b5c11922643dd3b62d0ddcd0184388faf83ead (patch) | |
| tree | dc8fcee29ee23089c456415062c32abb0468c823 /sql/mf_iocache.cc | |
| parent | 56c88d4a52fad96c95a43f0483c17456bf7aa99b (diff) | |
| download | mariadb-git-91b5c11922643dd3b62d0ddcd0184388faf83ead.tar.gz | |
Doxygenization of comments.
Diffstat (limited to 'sql/mf_iocache.cc')
| -rw-r--r-- | sql/mf_iocache.cc | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/sql/mf_iocache.cc b/sql/mf_iocache.cc index 5d9d6d834b4..8c2d16c40b0 100644 --- a/sql/mf_iocache.cc +++ b/sql/mf_iocache.cc @@ -13,8 +13,11 @@ along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -/* - Cashing of files with only does (sequential) read or writes of fixed- +/** + @file + + @details + Caching of files with only does (sequential) read or writes of fixed- length records. A read isn't allowed to go over file-length. A read is ok if it ends at file-length and next read can try to read after file-length (and get a EOF-error). @@ -34,11 +37,15 @@ extern "C" { - /* - ** Read buffered from the net. - ** Returns 1 if can't read requested characters - ** Returns 0 if record read - */ +/** + Read buffered from the net. + + @retval + 1 if can't read requested characters + @retval + 0 if record read +*/ + int _my_b_net_read(register IO_CACHE *info, uchar *Buffer, size_t Count __attribute__((unused))) |