Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kris-rowe committed Dec 11, 2023
1 parent 19a8922 commit 7f4906b
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions include/occa/core/memory.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -307,17 +307,18 @@ namespace occa {
* @startDoc{copyFrom[0]}
*
* Description:
* Copies data from the input `src` to the caller [[memory]] object
* Copies `count` elements from `src` into caller's data buffer, beginning at `offset`.
*
* Arguments:
* src:
* Data source.
*
* bytes:
* How many bytes to copy.
* count:
* The number of elements of type [[dtype_t]] to copy.
*
* offset:
* The [[memory]] offset where data transfer will start.
* The number of elements from beginning of the caller's
* data buffer the destination range is shifted.
*
* props:
* Any backend-specific properties for memory transfer.
Expand Down Expand Up @@ -367,17 +368,18 @@ namespace occa {
* @startDoc{copyTo[0]}
*
* Description:
* Copies data from the input `src` to the caller [[memory]] object
* Copies `count` elements to `dest` from caller's data buffer, beginning at `offset`.
*
* Arguments:
* dest:
* Where to copy the [[memory]] data to.
*
* bytes:
* How many bytes to copy
* count:
* The number of elements of type [[dtype_t]] to copy
*
* offset:
* The [[memory]] offset where data transfer will start.
* The number of elements from beginning of the caller's
* data buffer the source range is shifted.
*
* props:
* Any backend-specific properties for memory transfer.
Expand Down

0 comments on commit 7f4906b

Please sign in to comment.