API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Logger%21...

This documentation topic is not part of a class -- it's merely in the same file as a class. Therefore, it should not be using self:: to link to something.

Comments

joachim created an issue. See original summary.

msankhala’s picture

Also, it is showing Enf of defgroup on document page which it should not.

End of "defgroup logging_severity_levels".

jwlockhart’s picture

I am working on this issue at #uoecontributiondayAug2018

I have created a patch, but wanted to run it past first before uploading the file, just to check it was along the correct lines.

diff --git a/core/lib/Drupal/Core/Logger/RfcLogLevel.php b/core/lib/Drupal/Core/Logger/RfcLogLevel.php
index e7aafab30a..cff99fa533 100644
--- a/core/lib/Drupal/Core/Logger/RfcLogLevel.php
+++ b/core/lib/Drupal/Core/Logger/RfcLogLevel.php
@@ -20,9 +20,9 @@
  * @see http://bugs.php.net/bug.php?id=18090
  * @see http://php.net/manual/function.syslog.php
  * @see http://php.net/manual/network.constants.php
- * @see self::getLevels()
+ * @see \Drupal\Core\Logger\RfcLogLevel::getLevels()
  *
- * @} End of "defgroup logging_severity_levels".
+ * @}
  */
 
 /**

@msankhala Just seen comment, I have removed end defgroup reference, happy to receive feedback and look at taking this forward.

jwlockhart’s picture

Status: Active » Needs review
msankhala’s picture

I think removing the end of defgroup is not the correct solution. See @defgroup documentation in api documentation standard. Looks like issue is with formatting or with the quotes within @defgroup.

joachim’s picture

msankhala’s picture

@jwlockhart You can submit the patch. Yes, you are right if @defgroup is defined as per syntax example 1 mentioned in documentation then End of "group_name" is not necessary.

Syntax example 1 for defining a group:

/**
 * @defgroup group_identifier Topic title goes here
 * @{
 * Summary line for the group/topic goes here.
 *
 * Additional documentation paragraphs go here.
 * @}
 */
msankhala’s picture

Version: 8.6.x-dev » 8.7.x-dev
Status: Needs work » Needs review
StatusFileSize
new561 bytes

@joachim Sorry You haven't submitted the patch so I am submitting the one. Also changing branch to 8.7.x.

joachim’s picture

Status: Needs review » Reviewed & tested by the community

Thanks! Looks good to me.

alexpott’s picture

Updating issue credit.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed and pushed 1781eeafc3 to 8.7.x and cf7c5cd81e to 8.6.x. Thanks!

Backported to 8.6.x since it is a docs fix.

  • alexpott committed 1781eea on 8.7.x
    Issue #2989686 by msankhala, joachim, jwlockhart: documentation topic...

  • alexpott committed cf7c5cd on 8.6.x
    Issue #2989686 by msankhala, joachim, jwlockhart: documentation topic...

Status: Fixed » Closed (fixed)

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