Drupal 7 is relying on a lot of classes. All classes and member functions within classes need to be documented. This is a critical issue for Drupal 7, because we need to have our API documented.

I'll start a comment below to collect a list of classes in Drupal 7 that need more documentation. Probably each should be in its own issue, each sub-issue NOT marked critical, and we'll leave just this one issue as critical to keep track.

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

We need to sort out what the doc standards are for classes before I can make a list of the classes that need more doc.
See #718596: Lacking standards for documenting classes, interfaces, methods

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Starting a list of issues that are part of this meta-issue:

Database classes: #718540: Better documentation in query.inc

Crell’s picture

Crell commented

Subscribe.

catch’s picture

catch
he/him
Primary language English
commented
Status: Active » Postponed

Marking postponed until #718596: Lacking standards for documenting classes, interfaces, methods is resolved.

stephen.moz’s picture

stephen.moz commented

track

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Here's an issue on a specific class:
#807158: DrupalDefaultEntityController properties are not documented

Eventually we will need to file issues on other classes.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Postponed » Active

Standards are now defined on:
http://drupal.org/node/1354#classes

It is now time to find specific classes that need documentation and file specific issues for them.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

OK.

Here's a list of issues related to this meta-issue:
#341038: Docblock for DatabaseStatementInterface is a bit off
#718540: Better documentation in query.inc
#807158: DrupalDefaultEntityController properties are not documented
#996924: DatabaseStatementEmpty has methods that are lacking documentation

I'll add more as more are filed...

Crell’s picture

Crell commented
Title: Many classes in Drupal 7 are lacking doc for methods and member variables » [Meta] API documentation for classes and interfaces is incomplete
Priority: Critical » Normal

Retitling, and downgrading since meta issues shouldn't be critical.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

I thought it was just the opposite: we set meta issues to critical, and not the mutliple issues they are collecting?

Crell’s picture

Crell commented

Hm, I was basing that on #238950-94: Meta: update.module RAM consumption, although since there are open dependent issues I may have misread it. I actually have no idea if there is a "real" standard for how to use meta issues, other than "whoever posts the most wins".

I'm not sure that a documentation thread should be critical to begin with, but I don't care all that much overall. :-)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Closed (duplicate)

This issue was taken over by
#1310084: [meta] API documentation cleanup sprint