Skip to content

Commit

Permalink
Add doxygen-style comment for ufat_cache_evict()
Browse files Browse the repository at this point in the history
  • Loading branch information
FreddieChopin committed Sep 10, 2019
1 parent 5461529 commit 140fe00
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions ufat_internal.h
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,20 @@ static inline ufat_cluster_t block_to_cluster(const struct ufat_bpb *bpb,
*/

int ufat_cache_open(struct ufat *uf, ufat_block_t blk_index, int skip_read);

/**
* \brief Evicts (flushes) cached blocks which overlap with given range.
*
* \pre `uf` is a valid pointer.
* \pre The filesystem pointed by `uf` is opened.
*
* \param [in] uf is a pointer to the filesystem
* \param [in] start is the index of starting block of the range
* \param [in] count is the number of blocks in the range
*
* \return 0 on success, negative error code (`ufat_error_t`) otherwise
*/

int ufat_cache_evict(struct ufat *uf, ufat_block_t start, ufat_block_t count);

/**
Expand Down

0 comments on commit 140fe00

Please sign in to comment.