discussed this with chx in #drupal after fatal errors were triggered by #715108: Make Merge queries more consistent and robust --> #839006: SPL autoloader should use require_once to be more robust..

we should add a note to say that moving a class requires an update to rebuild the registry, chx suggested here would be a good place:

http://api.scratch.drupal.org/api/Drupal/classes/d7

Comments

chx’s picture

pwolanin’s picture

is this against API, or needs to go into Drupal core?

drumm’s picture

Category: task » feature
Status: Active » Postponed (maintainer needs more info)

This 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.

jhodgdon’s picture

Project: API » Documentation
Version: master »
Component: Documentation » New documentation
Category: feature » bug
Status: Postponed (maintainer needs more info) » Active

That 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?

arianek’s picture

Issue tags: +d7docs

adding tags

Anonymous’s picture

Component: New documentation » Correction/Clarification
Assigned: » Unassigned