Problem/Motivation
All related plugin classes and interfaces for a plugin type need to be linked together in documentation, so that developers can discover how to make that type of plugin. Also, there should be a link to the plugin_api topic in their documentation headers, which tells how to make plugins in general. (See #2269389: [meta] Make sure plugin developer info is discoverable for discussion, if interested.)
For any plugin type, here are the classes and interfaces that need to be located and linked together:
- The interface for the plugin (if there is one -- most plugins have one)
- The base class for the plugin (if there is one -- most plugins have one)
- The plugin manager class
- The annotation class
Developers also need to know the plugin namespace that plugin classes have to be put into, in order to be recognized.
And it would be helpful for them to have a link to one working example of a plugin.
Proposed resolution
This issue is for: The InPlaceEditor plugin type
The specific tasks to be done:
a) Locate the annotation class, interface, base class (if there is one), and plugin manager class for this plugin type. Find a working example class too. And figure out what the plugin namespace has to be. There are notes below on how to do this.
b) Make sure that all these classes and interfaces are linked together with @see links or are mentioned in each other's documentation headers. Example of a @see link:
* @see \Drupal\foo\bar\FooBarPluginInterface
c) Make sure that all of these classes and interfaces have:
* @see plugin_api
in their documentation headers.
d) Make sure that the annotation class documents the plugin namespace like this:
* Plugin Namespace: Plugin\Foo
e) In the Annotation class, also put in a line linking to the working example:
* For a working example, see \Name\Of\Plugin\Class
Remaining tasks
See Proposed Resolution.
Note:
All of the added lines should go into the class or interface documentation block, meaning the documentation immediately before the class/interface declaration:
/**
* (This is the interface documentation block/)
*/
class WhateverInterface extends Plugin {
Plain text lines like "Plugin Namespace: ..." should go before any @see or @ingroup lines, and the @Annotation line has to come last in any docs header.
Some notes on how to do this
You can find the annotation class on
https://api.drupal.org/api/drupal/core!modules!system!system.api.php/gro...
To find the a working example, look for a class in the Drupal Core code base that is annotated with the annotation class (using grep). For instance, if the annotation class is "Foo", search for a class that has "@Foo(" (without the quotes) in its documentation header.
Once you have located a working example, look at its class hierarchy (you can do this easily on api.drupal.org). It will most likely be extending a class called something like "FooBase", which would be the base class, and FooBase will most likely be implementing an interface called something like "FooInterface", which would be the plugin interface.
To find the manager class, take a look at the "Expanded class hierarchy of DefaultPluginManager" page:
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Plugin!DefaultPlu...
Look for a class there called FooPluginManager or something similar.
Once you have found the manager class, look at its __construct() method. It will call parent::construct(), passing in the annotation class and the plugin namespace. Verify that the right annotation class is shown, and take note of the plugin namespace is (typically something like "Plugin/Foo".
User interface changes
None.
API changes
None.
Comment | File | Size | Author |
---|---|---|---|
#14 | drupal8-inplace-editor-plugin-docs-2290269-13.patch | 2.71 KB | er.pushpinderrana |
Comments
Comment #1
er.pushpinderrana CreditAttribution: er.pushpinderrana commentedPlease review.
Comment #2
jhodgdonThanks!
These two lines need a blank line between them:
Also, I think the links to the Annotation classes have the wrong namespaces?
Comment #3
amitgoyal CreditAttribution: amitgoyal commentedAlthough I have added a blank line but not sure what's wrong with namespaces. Please clarify.
Comment #4
jhodgdonThe annotation class is \Drupal\quickedit\Annotation\InPlaceEditor, right?
The links in the base class, interface, and manager say:
"Plugin" in place of "Annotation".
Comment #5
amitgoyal CreditAttribution: amitgoyal commentedOh yes, please review updated patch as per fixes in #4.
Comment #6
jhodgdonThanks, looks good now!
Comment #7
Wim Leerss/I/i/
Comment #8
Wim LeersOne more:
Missing trailing period.
And why the fully qualified class names? All of these are in the same namespace already!
Comment #9
jhodgdonWe generally want fully-qualified class names in *all* documentation headers, according to standards.
And ... I generally agree a trailing . is a good idea, but not necessarily in this case where it directly follows a class name and it's only one line of docs...
Comment #11
jhodgdonPlease leave this in documentation component.
Comment #12
jhodgdonAs requested, this is going back to quickedit.module so the maintainers can oversee this patch. If you get it to RTBC and want me to commit it, please move it back to the "documentation" component.
Comment #13
jhodgdonThis patch just needs a quick fix for #7 (an upper-case I needs to be lower-case i). Can someone please make a new patch?
Comment #14
er.pushpinderrana CreditAttribution: er.pushpinderrana commentedThanks @jhodgdon!
Please review updated patch.
Comment #15
jhodgdonThanks, looks good to me! Let's give it a few days for the maintainers to review, then commit it.
Comment #16
alexpottCommitted 2212b4b and pushed to 8.0.x. Thanks!