From 9c542643216a1b66cda5311a4f2ee976e44a8cd5 Mon Sep 17 00:00:00 2001 From: Jason Rhinelander Date: Tue, 30 Jun 2020 18:48:09 -0300 Subject: [PATCH] Doc fix - remove "init" and update "start" doc init() got removed during the tagged threads PR, but the documentation didn't get updated. Fixed it. --- lokimq/lokimq.h | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/lokimq/lokimq.h b/lokimq/lokimq.h index ac76b4d..0fa49f5 100644 --- a/lokimq/lokimq.h +++ b/lokimq/lokimq.h @@ -865,12 +865,9 @@ public: * * \param name - the name of the thread; will be used in log messages and (if supported by the * OS) as the system thread name. - * \param init - an optional callback to invoke from the thread immediately after creating it. - * This can be used to perform initialization, however should not depend on LokiMQ having - * started. * - * \param start - similar to init, but this is called immediately *after* the LokiMQ object has - * started up and so can use LokiMQ object functionality. + * \param start - an optional callback to invoke from the thread as soon as LokiMQ itself starts + * up (i.e. after a call to `start()`). * * \returns a TaggedThreadID object that can be passed to job(), batch(), or add_timer() to * direct the task to the tagged thread.