This is a patch to improve documentation summaries in the node module to better conform to Doxygen and comment formatting conventions and improve consistency.
I focused on creating/improving the one-line summaries; particularly useful in IRC w/Druplicon. Obviously more extensive documentation is warranted in places, but I'd ask to keep this issue focused on summaries.
Particularly in need of review are these previously undocumented functions:
/**
* Helper function for node_admin_content()'s delete operation.
*
* @see node_admin_content()
*/
function node_multiple_delete_confirm($form, &$form_state, $nodes) {
/**
* Submit handler for the multiple node delete confirmation form.
*
* @see node_multiple_delete_confirm()
*/
function node_multiple_delete_confirm_submit($form, &$form_state) {
/**
* Checks if the current user may do the given operation on the given revision.
*/
function _node_revision_access($node, $op = 'view') {
/*
* Checks if the current user may add nodes.
*/
function _node_add_access() {
/**
* Returns when the given node last changed.
*/
function node_last_changed($nid) {
/**
* Menu callback; presents the add page form.
*/
function node_add_page() {
/**
* Submit handler for the 'Preview' button on the node form.
*/
function node_form_build_preview($form, &$form_state) {
/**
* Submit handler for the 'Revert' button on the node revert form.
*/
function node_revision_revert_confirm_submit($form, &$form_state) {
/**
* Asks for confirmation of the revision deletion.
*/
function node_revision_delete_confirm($form, $form_state, $node_revision) {
/**
* Submit handler for the 'Delete' button on the delete revision form.
*/
function node_revision_delete_confirm_submit($form, &$form_state) {
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | node-doxygen-cleanup.patch | 18.41 KB | claar |
| node-doxygen-cleanup.patch | 18.41 KB | claar |
Comments
Comment #2
claar commentedTestbot ignoring my patch.. re-uploading.
(Edit: Ends up tests aren't running because of HEAD being broken -- #1097100: Remove all 7xxx update functions and tests (D6 to D7 upgrade path))
Comment #3
marvil07 commentedGreat to have see new descriptions for functions, sadly this patch no longer applies(apart from core directory change).
Comment #6
arunkumarkPatch no longer applies cleanly.
Comment #13
quietone commented@claar, thank you for the report and the patch.
The node module docs were improved in #1313980: Clean up API docs for node module closing this as a duplicate.