Active
Project:
Documentation
Component:
Correction/Clarification
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Anonymous (not verified)
Created:
28 Jun 2010 at 01:44 UTC
Updated:
21 Sep 2024 at 10:25 UTC
Jump to comment: Most recent
Comments
Comment #1
chx commented#534594: [meta] system info cache writing and registry rebuilding is broken without a full bootstrap relevant too
Comment #2
pwolanin commentedis this against API, or needs to go into Drupal core?
Comment #3
drummThis is asking for a new comment-level command, like @file, @mainpage, and @defgroup, to add docs to listing pages. This page is simply a list of all classes. I'm not aware of any existing precedent from http://manual.phpdoc.org/HTMLframesConverter/default/ or http://www.stack.nl/~dimitri/doxygen/commands.html.
I would recommend documenting this on hook_update_N(), registry_rebuild(), and/or in the handbook.
Comment #4
jhodgdonThat is an interesting idea, to be able to add text to go at the top of various types of listing pages:
function
class
constant
topic
file
It could actually be useful as a feature request for the API module.
Given that this feature does not currently exist in the API module... I can't actually think of a good place to add documentation that if you move a class to a different file, you need to rebuild the registry. I think it should go in the Handbook some place.
So we need to split this issue into two pieces: (1) API feature request and (2) Documentation project issue to add this information to the handbook somewhere.
Since this original issue (and the title) addresses (2), I just filed a separate issue for (1). #839550: Ability to add documentation headers to global listing pages (Classes, Functions, etc.)
We also need to figure out where in the Handbook this documentation belongs... somewhere in the section (if it exists) that talks about Object Oriented programming in Drupal?
Comment #5
arianek commentedadding tags
Comment #6
Anonymous (not verified) commentedComment #7
avpaderno