We have set a standard in core for documenting any hooks in modulename.api.php. Here's a small new robotstxt.api.php that documents hook_robotstxt().

CommentFileSizeAuthor
0-robotstxt-api-D6.patch574 bytesdave reid

Comments

hass’s picture

This seems to be a new D7 rule only, isn't it?

dave reid’s picture

We have started it for core in D7, but there's nothing that says that module maintainers can't implement it for their modules now as well. If we are ever to have a contrib API site, modules would need to implement their own *.api.php files.

Here's the list of some modules that already implement their own *.api.php:
WYSIWYG API
Administration theme
Signup
ImageCache
Web Services

This standard for documentation was decided fairly recently, but I expect more and more contrib modules to be following this standard as it progresses. I see no reason why we shouldn't help set the standard. :)

dave reid’s picture

Issue tags: +Needs backport to D5
hass’s picture

Status: Needs review » Fixed

Committed to D6, changed doubles quotes to single quotes.

dave reid’s picture

Thanks very much hass!

Status: Fixed » Closed (fixed)
Issue tags: -Needs backport to D5

Automatically closed -- issue fixed for 2 weeks with no activity.