Create API documentation for
hook_feedapi_mapper()
and upcoming
hook_feedapi_mapper_elements() #369702: hook_feedapi_mapper_elements() to allow elements list be extended
D7 style in feedapi_mapper.api.php
| Comment | File | Size | Author |
|---|---|---|---|
| #3 | 369728_api_doc_elements.patch | 2.6 KB | alex_b |
Comments
Comment #1
akahn commentedThis file seems to be in the 6 branch: http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/feedapi_map...
But there is something weird going on with the 5 branch:
http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/feedapi_map...
You get an error when you click the file in the CVS browser, and it's not in the 5.x-1.1 tarball.
Comment #2
alex_b commentedakahn, the problem you describe is a ViewVc problem.
There's no documentation planned for 5.x, if you'd like to contribute a backport of the documentation in 6.x, please post a patch on a new issue :) - makes it easier to understand issues later...
Closing...
Comment #3
alex_b commentedakahn: your comment made me realize that there was a hook undocumented.
Comment #4
akahn commentedI'm willing to contribute API documentation for 5.x if the changes in the API from 5.x to 6.x are as simple as they appear (talking about hook_feedapi_mapper()). That is, $field_name is not optional in 5.x and the arguments are in a different order. Is there anything more to it? (I was racking my brains over this all morning until I realized that the order of the arguments changed from 5 to 6 and I was reading the 6.x API doc)
I haven't looked at hook_feedapi_mapper_elements() yet.
Comment #5
alex_b commentedYeah, there is more to it: Previous to 6.9 mappers didn't define their mapping targets. But you should be able to pull the documentation from a pre 6.9 version and backport it to 5.
Comment #6
alex_b commentedCommitted. akahn: If you'd like to backport API documentation to 5.x, please open a new issue for it. Thank you.