thread: Add doxygen headers for spdk_thread and spdk_poller

They now show up as hyperlinks when referred to in the documentation.

Change-Id: Iff85b050a78de82ad84d82d32f7e80177e9a9b35
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/470526
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
Ben Walker 2019-10-04 15:09:06 -07:00 committed by Jim Harris
parent 568f4d2b3a
commit 9a650e34ad

View File

@ -47,10 +47,18 @@
extern "C" {
#endif
/**
* A stackless, lightweight thread.
*/
struct spdk_thread;
struct spdk_io_channel_iter;
/**
* A function repeatedly called on the same spdk_thread.
*/
struct spdk_poller;
struct spdk_io_channel_iter;
/**
* A function that is called each time a new thread is created.
* The implementor of this function should frequently call