API Documentation for hook_clone_node_alter()

In the 7.x version the signature is different:
drupal_alter('clone_node', $node, $context);

Ideally this is documented in a new api.node_clone.inc file for D7.

clone.api.php

/**
 * @file
 * API documentation for the Node Clone module.
 */

/**
 * Conduct alterations to the node after prepopulation of its fields.
 *
 * @param $node
 *   The node of which is being prepopulated.
 * @param $context
 *   An array of context associated during this prepopulation step. Holds a
 *   "method", and "original_node" values to help determine the current context
 *   of the node.
 */
function hook_clone_node_alter(&$node, $context) {
}

/**
 * Change the access granted to clone the given node.
 */
function hook_clone_access_alter(&$access, $node) {
}

Just for reference: there is also some text in clone.pages.inc.

function clone_node_prepopulate($original_node) {
  if (isset($original_node->nid)) {
    global $user;

    if (clone_is_permitted($original_node->type)) {
      ...
      // Let other modules do special fixing up.
      // The function signature is: hook_clone_node_alter(&$node, $context)
      // $context is an array with two elements, 'method' and 'original_node',
      // where 'method' is either 'prepopulate' or 'save-edit'.
      $context = array('method' => 'prepopulate', 'original_node' => $original_node);
      drupal_alter('clone_node', $node, $context);
      // Make sure the file defining the node form is loaded.
      module_load_include('inc', 'node', 'node.pages');
      return drupal_get_form($node->type .'_node_form', $node);
    }
  }
}

I was just using node_clone for a project and wanted to know if it invoked any hooks. Didn't see clone.api.php. Grepped the code. Found the alter hooks, and wrote my own API docs to contribute. Was about to submit a new issue but searched first and found this. ;) Here are patches for both D6 and D7, ready for git am goodness.

Cheers,
-Derek

This is nice - it took me a long time before mastering the hook_alter, although it is mentioned in the docu.
Perhaps you can add the following switch + simplification in the example:

function hook_clone_node_alter(&$node, $context) {
  switch ($context['method']) {
    case 'prepopulate':
      if ($node->type = 'special') {
        $node->special = special_something();
      }
      break;

    case 'save-edit':
      break;
  }
}

Thanks dww!

do we really need to remove the inline docs, or you just think that will get stale?

Sure! :) Just seems pointless to duplicate them in multiple places where people aren't going to look. [module].api.php is the ubiquitous standard now, so if we've got that, we're set.

Cheers,
-Derek

committed to 6 and 7