Merge pull request #566 from emacs-php/fix/phpdoc-inheritdoc

Support PHPDoc {@inheritdoc} tag
emacs-php · Aug 26, 2019 · e28eada · e28eada
2 parents bfc5b7d + 01569d9
commit e28eada
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 2 deletions.
diff --git a/php-mode.el b/php-mode.el
@@ -1436,7 +1436,7 @@ a completion list."
         "return" "throws" "var"))
 
 (defconst php-phpdoc-font-lock-doc-comments
-  `(("{@[-[:alpha:]]+\\s-\\([^}]*\\)}" ; "{@foo ...}" markup.
+  `(("{@[-[:alpha:]]+\\s-*\\([^}]*\\)}" ; "{@foo ...}" markup.
      (0 'php-doc-annotation-tag prepend nil)
      (1 'php-string prepend nil))
     (,(rx (group "$") (group (in "A-Za-z_") (* (in "0-9A-Za-z_"))))

diff --git a/tests/doc-comment/inheritdoc.php b/tests/doc-comment/inheritdoc.php
@@ -0,0 +1,5 @@
+<?php
+
+/**
+ * {@inheritdoc}
+ */
diff --git a/tests/doc-comment/inheritdoc.php.faces b/tests/doc-comment/inheritdoc.php.faces
@@ -0,0 +1,7 @@
+;; -*- mode: emacs-lisp -*-
+(("<?php" . php-php-tag)
+ ("\n\n")
+ ("/**\n * " . font-lock-doc-face)
+ ("{@inheritdoc}" php-doc-annotation-tag font-lock-doc-face)
+ ("\n */" . font-lock-doc-face)
+ ("\n"))
diff --git a/tests/doc-comment-return-type.php → tests/doc-comment/return-type.php b/tests/doc-comment-return-type.php → tests/doc-comment/return-type.php
diff --git a/tests/doc-comment-return-type.php.faces → tests/doc-comment/return-type.php.faces b/tests/doc-comment-return-type.php.faces → tests/doc-comment/return-type.php.faces
diff --git a/tests/php-mode-test.el b/tests/php-mode-test.el
@@ -672,7 +672,8 @@ Meant for `php-mode-test-issue-503'."
                        :faces (cond ((eq emacs-major-version 24) ".24.faces")
                                     ((version<= "27" emacs-version) ".27.faces")
                                     (t t))))
-  (with-php-mode-test ("doc-comment-return-type.php" :faces t))
+  (with-php-mode-test ("doc-comment/return-type.php" :faces t))
+  (with-php-mode-test ("doc-comment/inheritdoc.php" :faces t))
   (with-php-mode-test ("lang/types/cast.php" :faces t))
   (with-php-mode-test ("lang/types/function.php" :faces t))
   (with-php-mode-test ("lang/types/keywords.php" :faces t))