API page: https://api.drupal.org/api/drupal/core%21modules%21views%21views.api.php...
This page has some somewhat minor issues that need to be fixed:
a) The "Implement hooks" bullet item has a link to the hooks topic, but the link actually goes to the Views class instead. It should say @link views_hooks Views hook topic @endlink
.
b) Typos:
ingration (should be integration)
c) Probably the \Drupal\views\Views class needs to be in an @see.
d) It would also probably help if all of the topics that are linked from this page had @ingroup views_overview
in their docs header. This would make them list on this page as "sub-topics".
Comments
Comment #1
kunalgrover05 CreditAttribution: kunalgrover05 commentedComment #2
kunalgrover05 CreditAttribution: kunalgrover05 commentedComment #4
kunalgrover05 CreditAttribution: kunalgrover05 commentedComment #5
jhodgdonThanks! This is pretty good, but it needs a little work:
a) Sorry for not being clear in the issue summary item (d). This one does not belong in the patch:
We actually only want the views-related topics to be listed as "sub-topics". So we should have the @ingroup lines in:
https://api.drupal.org/api/drupal/core!modules!views!views.api.php/group...
https://api.drupal.org/api/drupal/core!modules!views!views.theme.inc/gro...
https://api.drupal.org/api/drupal/core!modules!views!views.api.php/group...
b) Also when you make these links, @ingroup should go at the *end* of documentation blocks, not at the beginning. See https://www.drupal.org/coding-standards/docs#order
c) I made a mistake in the issue summary, and:
Should say "Views hooks topic" not "Views hooks topic". My bad!
d)
Take the word "class" off the end of this line.
e) It looks like the Views Plugins topic is missing the @{. Can you add it? So here:
It should end up looking like this:
See https://www.drupal.org/coding-standards/docs#defgroup for details on syntax. It might need a @} at the end also. I am not sure why this is working at all really!
Comment #6
kunalgrover05 CreditAttribution: kunalgrover05 commentedComment #7
jhodgdonExcellent! Looks perfect now. Thanks very much for the fast work and both patches.
Comment #8
alexpottDocumentation is not frozen in beta. Committed 69c9962 and pushed to 8.0.x. Thanks!