I made a sandbox where I'm updating views.api.php. All hooks now have documentation and code examples, and some of them need review.

Two notes:
* In the sandbox I have moved views.api.php to Views' root catalog, which make much sense to me. (It took me some time to find the file when it was inside /docs.)
* There are lines marked with tripple stars (***) where I am uncertain and would like an expert to review.

The sandbox is found here: http://drupal.org/sandbox/itangalo/1489684

Comments

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
CreditAttribution: tim.plunkett commented

Small note: Unlike every other function docblock, hooks definitions are in the imperative form, so Describe plugins defined by the module. not Describes plugins defined by the module.

I'll be looking through the *** ones, if you want to give me commit access to your sandbox I can remove the stars or tweak the docs where I can.

Itangalo++

Itangalo’s picture

Itangalo CreditAttribution: Itangalo commented

Thanks x 3! Commit access granted to sandbox – and also access to add more maintainers if there should be reason.

I hope to work more with the file later on today, so it might be good to pull/push every once in a while. Cheers!

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner commented

Feel free to give me commit access as well, so i can help here.

+ *     - uses options: Set to TRUE to denote that the row plugin has an
+ *       additional options form.

Based on this option there is a link to configure settings for the plugin. Uses options actually exists for all plugins.

+ *     - uses fields: Set to TRUE to have the row plugin accept field handlers.

This flag can be set on style plugins as well, because there might be style plugins without fields itself, i'm not sure of one example maybe some very specialized ones.

As all the checks happens with !empty it's not that required.

+ *     - parent: The name of the plugin this plugin extends.***

I'm not sure but i think 'parent' is not required for d7 at all anymore. In d6 it was used to get the parent class loaded.
In general i think it's still helpful as this somehow documents the interdependency between the different plugins.

+  //   - 'argument': A description of any argument handler for the table field.

You can add an area handler as well.

contextual links locations:

Should be moved to display plugins.

Itangalo’s picture

Itangalo CreditAttribution: Itangalo commented

Commit access added!

Itangalo’s picture

Itangalo CreditAttribution: Itangalo commented

Comments in #3 committed to sandbox, moving along with more commenting!

Itangalo’s picture

Itangalo CreditAttribution: Itangalo commented

All hooks now have code examples! Moving on to see how I can improve more API docs further.

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner commented

Merge time! i merged the current version in, really really great work!

Thanks for all the effort in the past and hopefully in the future :)

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
CreditAttribution: tim.plunkett commented
Status: Needs review » Fixed

I think this is okay for now?

Itangalo’s picture

Itangalo CreditAttribution: Itangalo commented
Status: Fixed » Closed (fixed)

Confirming that this is now merged into Views. (Thanks for the nudge.)

Itangalo’s picture

Itangalo CreditAttribution: Itangalo commented
Issue summary: View changes

Updated the issue summary.