Similar to #1871762: Add detailed documentation explaining the block system's architecture we want to document the available plugin types in views in all the base plugins.
This for sure could/should be done later, but just want to create an issue for it.
Comments
Comment #1
xjmThis is sort of a duplicate of part of the scope defined in #1856544: [META] Views documentation improvements, but let's use it as a sub-issue. From that issue:
This is also the sort of docs issue that we can allow now, since it's critical documentation. (In fact "Basic API docs for all base plugins & important objects complete" is on our D8 goals chart for Feb. 18).
Comment #2
xjmLet's make this an easier novice task by creating sub-issues for each base plugin. To help with this issue:
core/modules/views/lib/Drupal/views/Plugin/views
directory.Pick one of these plugin types and create an issue for it. Link the issue here, in this issue's summary.
@ingroup
reference to the group for its plugin or handler type (defined on the base plugin), and that it is at the end of the class docblock.views.api.php
for some starting point information. The VDC team can also help you with this part.Two more advanced but very important tasks would be to add such documentation to
PluginBase
andHandlerBase
.Comment #3
thsutton CreditAttribution: thsutton commentedI've started work on the
pager
directory in #1912650: Document all views pager plugins types.Comment #4
thsutton CreditAttribution: thsutton commentedHow did I delete the tags?
Comment #5
thsutton CreditAttribution: thsutton commentedI've started work on the
access
directory in #1912658: Document views access plugins.Comment #6
dawehner@thsutton Thanks for working on that!!!!!!!!
Comment #7
jhodgdonI think this can be marked as fixed now, or as a duplicate of #2216539: Fill in @defgroup/topic docs for Views overview?