diff options
| author | David Robillard <d@drobilla.net> | 2021-01-06 23:53:30 +0100 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2021-01-06 23:53:30 +0100 |
| commit | 31d059bf849045f45c8c9db361efd093e88a109c (patch) | |
| tree | 1c721d9115ede87b8540a046c08e748cd4fae897 /bindings | |
| parent | a0de85eae094bd440dc4b4c45339be9571748484 (diff) | |
| download | pugl-31d059bf849045f45c8c9db361efd093e88a109c.tar.gz pugl-31d059bf849045f45c8c9db361efd093e88a109c.tar.bz2 pugl-31d059bf849045f45c8c9db361efd093e88a109c.zip | |
Fix documentation formatting issues
Diffstat (limited to 'bindings')
| -rw-r--r-- | bindings/cxx/include/pugl/pugl.hpp | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/bindings/cxx/include/pugl/pugl.hpp b/bindings/cxx/include/pugl/pugl.hpp index 8758a17..fc3bb03 100644 --- a/bindings/cxx/include/pugl/pugl.hpp +++ b/bindings/cxx/include/pugl/pugl.hpp @@ -601,9 +601,8 @@ public: resolution on Windows) and may be rounded up if it is too short. On X11 and MacOS, a resolution of about 1ms can usually be relied on. - Errors: - - #PUGL_FAILURE if timers are not supported by this system or build. - - #PUGL_UNKNOWN_ERROR if setting the timer failed. + @return #PUGL_FAILURE if timers are not supported by the system, + #PUGL_UNKNOWN_ERROR if setting the timer failed. */ Status startTimer(const uintptr_t id, const double timeout) noexcept { @@ -615,9 +614,8 @@ public: @param id The ID previously passed to startTimer(). - Errors: - - #PUGL_FAILURE if timers are not supported by this system or build. - - #PUGL_UNKNOWN_ERROR if stopping the timer failed. + @return #PUGL_FAILURE if timers are not supported by this system, + #PUGL_UNKNOWN_ERROR if stopping the timer failed. */ Status stopTimer(const uintptr_t id) noexcept { |