Re: Documentation typos
Duncan Grisby via omniORB-list <[email protected]> Tue, 24 Jun 2025 10:01:51 +0100
| Newsgroups | gmane.comp.corba.omniorb.user |
|---|---|
| Message-ID | <[email protected]> |
On Sun, 2025-06-22 at 23:44 +0200, Thomas Braun via omniORB-list wrote: > The documentation at [1] says: > > > A wait with a timeout can be achieved by calling timed_wait(). This > > is given an absolute time to wait until. The routine > > omni_thread::get_time() can be used to turn a relative time into an > > absolute time. timed_wait() returns true if the condition was > > signalled, false if the time expired before the condition variable > > was signalled. > > But here with 4.3.3 the function is called timedwait() and it also > returns an integer. In other parts of the documentation it says > TRUE(1). > > [1]: https://omniorb.net/omni43/omnithread.html Thanks! The error in function naming has existed in that document for ever. I guess nobody has ever paid much attention. I have updated it. The return type is correct, though. omnithread is extremely old and predates C++ having a bool type, so it uses int with the semantics of a boolean. Thanks, Duncan. -- Duncan Grisby <[email protected]>