1
0
mirror of https://github.com/pevans/erc-c.git synced 2024-12-08 14:51:18 +00:00

Add missing docblocks

This commit is contained in:
Peter Evans 2018-02-03 21:56:27 -06:00
parent 67f943d891
commit 2bdc921b76
2 changed files with 19 additions and 0 deletions

View File

@ -92,6 +92,11 @@ apple2_dd_insert(apple2dd *drive, FILE *stream, int type)
return OK;
}
/*
* Encode the drive image segment into the drive data segment using
* 6-and-2 encoding, if necessary. (It is not necessary if the
* image_type is DD_NIBBLE.)
*/
void
apple2_dd_encode(apple2dd *drive)
{
@ -111,6 +116,10 @@ apple2_dd_encode(apple2dd *drive)
}
}
/*
* Save the contents of the drive back to the file system (given as the
* stream field in the drive struct).
*/
void
apple2_dd_save(apple2dd *drive)
{
@ -124,6 +133,11 @@ apple2_dd_save(apple2dd *drive)
}
}
/*
* Decode the drive data segment into the drive image segment, reversing
* the 6-and-2 encoding (if need be -- see note on DD_NIBBLE for the
* encode function).
*/
void
apple2_dd_decode(apple2dd *drive)
{

View File

@ -286,6 +286,11 @@ vm_segment_fread(vm_segment *segment, FILE *stream, size_t offset, size_t len)
return OK;
}
/*
* Write the contents of a segment into a given file stream, using an
* offset and a length for the contents to write. If this operation
* works out, we return OK.
*/
int
vm_segment_fwrite(vm_segment *seg, FILE *stream, size_t off, size_t len)
{