Core has started a standard of documenting all its hooks in modulename.api.php, which is starting to spread throughout contrib. I've noticed in the readme that in order to view the node_import documentation, I have to run doxygen myself. What if a developer is not able to do that? Please consider providing a well-documented node_import.api.php in the root of the module for other developers.

Comments

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented

And of course, now I see that there is a file called hook_node_import_docs.php. Consider updating the README and renaming the file to node_import.api.php. :)

Robrecht Jacques’s picture

Robrecht Jacques commented
Status: Active » Needs work

Renamed hook_node_import_docs.php.

How is a developer supposed to see the documentation now (instead of running doxygen themselves)? Leaving this open for a reply so I can modify README.txt.

Thanks.

patcon’s picture

patcon commented

It seems this got switched back, and it's throwing off user_import's content profile importing :)

Robrecht Jacques’s picture

Robrecht Jacques commented
Status: Needs work » Closed (duplicate)

This has been fixed.

The documentation itself needs more work: see http://drupal.org/node/374350.

Setting as duplicate.