There are some classes/functions that need @ingroup lines added to them, so that they will be connected to relevant topics. See
https://www.drupal.org/node/1354#defgroup
for the syntax of @ingroup.

Here's the list:

a) On https://api.drupal.org/api/drupal/core!includes!form.inc/group/form_api/8 several classes and interfaces are mentioned in the documentation (FormInterface, FormBuilder, FormBase). These should all have "@ingroup form_api" added to their documentation.

b) drupal_get_destination() needs @ingroup form_api

c) file_get_references needs @ingroup file

d) https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Queue!QueueInterf... and any classes/interfaces that implement/extend it (ReliableQueueInterface, Memory, BatchMemory, DatabaseQueue, Batch) should be given @ingroup queue.

CommentFileSizeAuthor
#4 ingroup-added-2299699-4.patch4.9 KBl0ke

Comments

BruceMWhealtonJr’s picture

Assigned: Unassigned » BruceMWhealtonJr

Hi, my name is Bruce (Bruce Whealton). I finally made it to a core mentoring meeting and this was my assignment. I've used Drupal for 8+ years and have hundreds of hours of self-paced online training... starting with admin, years ago, and then moving up to module development in php. I'm excited about the cool new features of D8. So, this is my first task.
I will now assign this to me.
Bruce

jhodgdon’s picture

Thanks, and welcome!

jhodgdon’s picture

Bruce: Are you still planning to make a patch for this issue?

l0ke’s picture

Status: Active » Needs review
StatusFileSize
new4.9 KB

Hi, here is the patch that adds @ingroup to the classes/functions you've listed in the topic.

jhodgdon’s picture

Assigned: BruceMWhealtonJr » Unassigned
Status: Needs review » Reviewed & tested by the community

Perfect, thanks!

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed 2691c42 and pushed to 8.x. Thanks!

  • alexpott committed 2691c42 on 8.x
    Issue #2299699 by lokeoke | jhodgdon: Some classes need @ingroup added...

Status: Fixed » Closed (fixed)

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

m1r1k’s picture

Issue tags: +#ams2014contest