Request checker documentation

Question

As someone who tags checkers to caches, I have found that many checkers have poor documentation as to what parameters they support. Either I have to hunt through the code to work out if something is supported, or hope I can find another tag that shows what I need.

Please fully document your options, at least put a summary in the checker description and full details at the top of the code (use --[[       ]]-- to comment out a number of lines)

And if you haven't already, please check your existing checkers and add the documentation.

It will make tagging a LOT easier!

thanks,

Tom

Comments

I have tried to document my checkers but I haven't gotten to all of them yet...

---

Also it would be cool to have documentation of API  functions. I would write some checkers, but since I can only guess the functions from existing checkers, it is MUCH harder.

---

There is documentation of all available API functions for checkers. All the documentation (and a forum) related to checker writing is at http://forum.project-gc.com/viewforum.php?f=10 (which is only available if you have privileges for writing checkers). The API documentation is in the Documentation thread, and then follow the link just under the "APIs from Project-GC" heading.

---

Is this the current link, because the ..f=10 link doesn't work anymore?
https://project-gc.com/forum/list?5

---

Yeah. There was some reorganization over the last 6 years. I think the right link would be https://project-gc.com/forum/list?7, but I do not think it is much significant now as all checker related things are really in these forums rather than in this QA.