Skip to content

optimize swoole timer docs - #4773

Open
NathanFreeman wants to merge 3 commits into
php:masterfrom
NathanFreeman:timer
Open

optimize swoole timer docs#4773
NathanFreeman wants to merge 3 commits into
php:masterfrom
NathanFreeman:timer

Conversation

@NathanFreeman

Copy link
Copy Markdown
Contributor

No description provided.

@NathanFreeman
NathanFreeman force-pushed the timer branch 3 times, most recently from e549eb6 to 4f57199 Compare July 12, 2025 06:03
Comment thread reference/swoole/swoole.timer.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/tick.xml Outdated
Comment thread reference/swoole/swoole/timer/after.xml Outdated
Comment thread reference/swoole/swoole/timer/info.xml Outdated
Comment thread reference/swoole/swoole/timer/info.xml Outdated
Comment thread reference/swoole/swoole/timer/info.xml Outdated
Comment thread reference/swoole/swoole/timer/info.xml Outdated
Comment thread reference/swoole/swoole/timer/clear.xml Outdated
Comment thread reference/swoole/swoole/timer/clear.xml Outdated
Comment thread reference/swoole/swoole/timer/clear.xml Outdated
Comment thread reference/swoole/swoole/timer/clear.xml Outdated
Comment thread reference/swoole/swoole/timer/clear.xml Outdated
Comment thread reference/swoole/swoole/timer/list.xml Outdated
Comment thread reference/swoole/swoole/timer/list.xml Outdated
Comment thread reference/swoole/swoole/timer/set.xml Outdated
Comment thread reference/swoole/swoole/timer/set.xml Outdated
Comment thread reference/swoole/swoole/timer/stats.xml Outdated
Comment thread reference/swoole/swoole.timer.xml Outdated
Comment thread reference/swoole/swoole.timer.xml Outdated
Comment thread reference/swoole/swoole.timer.xml Outdated
Comment thread reference/swoole/swoole/timer/info.xml Outdated
Comment thread reference/swoole/swoole/timer/clearAll.xml Outdated
Comment thread reference/swoole/swoole/timer/clearAll.xml Outdated
Comment thread reference/swoole/swoole/timer/stats.xml Outdated
Comment thread reference/swoole/swoole/timer/info.xml Outdated
Comment thread reference/swoole/swoole/timer/info.xml Outdated
@lacatoire

Copy link
Copy Markdown
Member

Thanks for working on these docs! One thing about the method set: in current swoole-src, the Swoole\Timer class method table (swoole_timer.cc) registers tick, after, exists, info, stats, list, clear, clearAll, but no set, so set.xml seems to document a method that no longer exists (looks like it was removed). Could you confirm? If it was dropped, the page probably shouldn't be added (or should carry a "removed as of ..." note).

Conversely, Swoole\Timer::exists(int $timer_id): bool is a real method but isn't documented anywhere, so it might be worth adding while we're here.

lacatoire and others added 2 commits August 20, 2026 11:38
Co-authored-by: Louis-Arnaud <la.catoire@gmail.com>
Co-authored-by: Luffy <lufei@apache.org>
Co-authored-by: Louis-Arnaud <la.catoire@gmail.com>
@NathanFreeman

Copy link
Copy Markdown
Contributor Author

Got it, thanks! I'll take a look this week or next. This is my first time contributing to the PHP documentation, so I'm still not very familiar with some parts. I'll make further improvements based on your feedback.

@NathanFreeman

Copy link
Copy Markdown
Contributor Author

Swoole\Timer::set has actually been deprecated. I'll check the version history to determine when it was removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants