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

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

larowlan’s picture

Issue tags: +Tour
er.pushpinderrana’s picture

Status: Active » Needs review
FileSize
2.09 KB

Please review patch.

er.pushpinderrana’s picture

FileSize
2.09 KB

Rerolled previous patch, corrected namespace.

jhodgdon’s picture

Status: Needs review » Needs work

Thanks!

These two lines need a blank line between them:

+ * Plugin Namespace: Plugin\tour\tip
+ * For a working example, see \Drupal\tour\Plugin\tour\tip\TipPluginText

And...

+++ b/core/modules/tour/src/TipPluginManager.php
@@ -12,7 +12,12 @@
 use Drupal\Core\Plugin\DefaultPluginManager;
 
 /**
- * Configurable tour manager.
+ * Provides a tour manager.

I'm not sure if I like this change. ... Looking at the Tour manager plugins as a whole... The annotation, interface, etc. are called "Tip", not "Tour". So I think the plugin manager, base class, and interface are actually for "tips", which are really items in tours, not entire tours.

So if we are going to fix up this class, could we fix up all the class/interface headers so they say "tour items" instead of "tours"?

So TipPluginManager would be "Provides a plugin manager for tour items.", TipPluginInterface is already OK, TipPluginBase would say "tour items" instead of "tours", and the Annotation class would say "tour item" instead of "tip"?

amitgoyal’s picture

Status: Needs work » Needs review
FileSize
2.25 KB
1.3 KB

Please review updated patch for fixes in #4.

jhodgdon’s picture

Component: documentation » tour.module
Status: Needs review » Needs work

Looking better, thanks!

+++ b/core/modules/tour/src/TipPluginBase.php
@@ -11,7 +11,12 @@
 use Drupal\tour\TipPluginInterface;
 
 /**
- * Defines a base tour implementation.
+ * Defines a base tour items implementation.

items -> item

The rest looks good, thanks!

I'm temporarily moving this to the Tour module in case the maintainers would like to comment on these changes.

joshi.rohit100’s picture

Status: Needs work » Needs review
FileSize
2.25 KB
419 bytes

updated patch as #6.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

This looks great! I'll mark RTBC and we should wait a few days in case the Tour module maintainers want to have some input. I'll also ping them in IRC.

nick_schuch’s picture

I have reviewed as well. Thanks for your work on this one everyone!

jhodgdon’s picture

Component: tour.module » documentation
Status: Reviewed & tested by the community » Fixed

Thank for the review Nick, and thanks everyone for the patches! Committed to 8.x.

  • jhodgdon committed 8b2d8f3 on 8.x
    Issue #2290281 by er.pushpinderrana, amitgoyal, joshi.rohit100,...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.