Commit 86ff24ab by Tianqi Chen Committed by GitHub

[DOC] Fix doxygen comments (#247)

parent f33147c2
......@@ -100,3 +100,23 @@ perf
nnvm
*.wasm
.emscripten
## IOS
DerivedData/
## Various settings
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata/
## Other
*.moved-aside
*.xccheckout
*.xcscmblueprint
.DS_Store
\ No newline at end of file
Subproject commit 2e1fcedfed1253289ade441a56427e44fb9c98aa
Subproject commit 7afa45b87ce639b29d809cc15149f0caa48ac6c4
......@@ -41,7 +41,6 @@ class DeviceAPI {
/*!
* \brief Set the environment device id to ctx
* \param ctx The context to be set.
* \return The allocated device pointer
*/
virtual void SetDevice(TVMContext ctx) = 0;
/*!
......@@ -64,7 +63,6 @@ class DeviceAPI {
* \brief Free a data space on device.
* \param ctx The device context to perform operation.
* \param ptr The data space.
* \tparam xpu The device mask.
*/
virtual void FreeDataSpace(TVMContext ctx, void* ptr) = 0;
/*!
......
......@@ -69,7 +69,7 @@ class RingBuffer {
/*!
* \brief Read data from buffer with and put them to non-blocking send function.
*
* \param frecv A send function handle to put the data to.
* \param fsend A send function handle to put the data to.
* \param max_nbytes Maximum number of bytes can to read.
* \tparam FSend A non-blocking function with signature size_t (const void* data, size_t size);
*/
......
......@@ -36,7 +36,7 @@ void LoadBinaryFromFile(const std::string& file_name,
/*!
* \brief Load binary file into a in-memory buffer.
* \param file_name The name of the file.
* \param The binary
* \param data The binary data to be saved.
*/
void SaveBinaryToFile(const std::string& file_name,
const std::string& data);
......
......@@ -39,7 +39,7 @@ struct RPCArgBuffer {
std::vector<std::unique_ptr<RPCDataArrayBuffer> > temp_array;
// convert buffer as TVMArgs
TVMArgs AsTVMArgs() const {
return TVMArgs(value.data(), tcode.data(), value.size());
return TVMArgs(value.data(), tcode.data(), static_cast<int>(value.size()));
}
};
......
......@@ -95,11 +95,10 @@ class RPCSession {
bool ServerOnMessageHandler(const std::string& bytes);
/*!
* \brief Call into remote function
* \param sptr_to_self shared_ptr to self.
* \param handle The function handle
* \param args The arguments
* \param rv The return value.
* \param fwrapper Wrapper function to turn Function/Module handle into real return.
* \param fwrap Wrapper function to turn Function/Module handle into real return.
*/
void CallFunc(RPCFuncHandle handle,
TVMArgs args,
......@@ -149,7 +148,6 @@ class RPCSession {
int nstep);
/*!
* \brief Call a remote defined system function with arguments.
* \param sptr_to_self shared_ptr to self.
* \param fcode The function code.
* \param args The arguments
* \return The returned remote value.
......
......@@ -35,7 +35,7 @@ class WorkspacePool {
/*!
* \brief Allocate temporal workspace.
* \param ctx The context of allocation.
* \param The size to be allocated.
* \param size The size to be allocated.
*/
void* AllocWorkspace(TVMContext ctx, size_t size);
/*!
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment