issue doxygen#11831 @ref not supported in <summary> tag

Added possibility to use the `\ref` command in the `<summary>` tag

Author: albert-github

src/docnode.cpp

@@ -1436,6 +1436,12 @@ void DocHtmlSummary::parse()
     {
       break;
     }
+    else if (((tok.value()==TokenRetval::TK_COMMAND_AT) || (tok.value()==TokenRetval::TK_COMMAND_BS)) &&
+             (Mappers::cmdMapper->map(parser()->context.token->name)== CommandType::CMD_REF))
+    {
+      parser()->handleRef(thisVariant(),children(),
+                          tok.value()==TokenRetval::TK_COMMAND_AT ? '@' : '\\',parser()->context.token->name);
+    }
     else if (!parser()->defaultHandleToken(thisVariant(),tok,children()))
     {
       parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"summary section");
@@ -3961,33 +3967,6 @@ void DocPara::handleLink(const QCString &cmdName,bool isJavaLink)
   }
 }
 
-void DocPara::handleRef(char cmdChar,const QCString &cmdName)
-{
-  AUTO_TRACE("cmdName={}",cmdName);
-  QCString saveCmdName = cmdName;
-  Token tok=parser()->tokenizer.lex();
-  if (!tok.is(TokenRetval::TK_WHITESPACE))
-  {
-    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after '{:c}{}' command",
-      cmdChar,qPrint(saveCmdName));
-    return;
-  }
-  parser()->tokenizer.setStateRef();
-  tok=parser()->tokenizer.lex(); // get the reference id
-  if (!tok.is(TokenRetval::TK_WORD))
-  {
-    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} as the argument of '{:c}{}'",
-        tok.to_string(),cmdChar,saveCmdName);
-    goto endref;
-  }
-  children().append<DocRef>(parser(),thisVariant(),
-                            parser()->context.token->name,
-                            parser()->context.context);
-  children().get_last<DocRef>()->parse();
-endref:
-  parser()->tokenizer.setStatePara();
-}
-
 void DocPara::handleInclude(const QCString &cmdName,DocInclude::Type t)
 {
   AUTO_TRACE("cmdName={}",cmdName);
@@ -4884,7 +4863,7 @@ Token DocPara::handleCommand(char cmdChar, const QCString &cmdName)
       break;
     case CommandType::CMD_REF: // fall through
     case CommandType::CMD_SUBPAGE:
-      handleRef(cmdChar,cmdName);
+      parser()->handleRef(thisVariant(),children(),cmdChar,cmdName);
       break;
     case CommandType::CMD_SECREFLIST:
       {

src/docnode.h

@@ -1100,7 +1100,6 @@ class DocPara : public DocCompoundNode
     void handleCite(char cmdChar,const QCString &cmdName);
     void handleDoxyConfig(char cmdChar,const QCString &cmdName);
     void handleEmoji(char cmdChar,const QCString &cmdName);
-    void handleRef(char cmdChar,const QCString &cmdName);
     void handleSection(char cmdChar,const QCString &cmdName);
     void handleInheritDoc();
     void handleVhdlFlow();

src/docparser.cpp

@@ -1199,6 +1199,35 @@ void DocParser::handleImage(DocNodeVariant *parent, DocNodeList &children)
   children.get_last<DocImage>()->parse();
 }
 
+void DocParser::handleRef(DocNodeVariant *parent, DocNodeList &children, char cmdChar, const QCString &cmdName)
+{
+  AUTO_TRACE("cmdName={}",cmdName);
+  QCString saveCmdName = cmdName;
+  int saveState = tokenizer.getState();
+  Token tok=tokenizer.lex();
+  if (!tok.is(TokenRetval::TK_WHITESPACE))
+  {
+    warn_doc_error(context.fileName,tokenizer.getLineNr(),"expected whitespace after '{:c}{}' command",
+      cmdChar,qPrint(saveCmdName));
+    return;
+  }
+  tokenizer.setStateRef();
+  tok=tokenizer.lex(); // get the reference id
+  if (!tok.is(TokenRetval::TK_WORD))
+  {
+    warn_doc_error(context.fileName,tokenizer.getLineNr(),"unexpected token {} as the argument of '{:c}{}'",
+        tok.to_string(),cmdChar,saveCmdName);
+    goto endref;
+  }
+  children.append<DocRef>(this,parent,
+                            context.token->name,
+                            context.context);
+  children.get_last<DocRef>()->parse();
+endref:
+  tokenizer.setState(saveState);
+}
+
+
 
 /* Helper function that deals with the most common tokens allowed in
  * title like sections.

src/docparser_p.h

@@ -136,6 +136,7 @@ class DocParser : public IDocParser
     void handleAnchor(DocNodeVariant *parent,DocNodeList &children);
     void handlePrefix(DocNodeVariant *parent,DocNodeList &children);
     void handleImage(DocNodeVariant *parent, DocNodeList &children);
+    void handleRef(DocNodeVariant *parent, DocNodeList &children, char cmdChar, const QCString &cmdName);
     void readTextFileByName(const QCString &file,QCString &text);
 
     std::stack< DocParserContext > contextStack;

src/doctokenizer.h

@@ -194,6 +194,9 @@ class DocTokenizer
     void pushState();
     void popState();
 
+    int  getState();
+    void setState(int newState);
+
     // operations on the scanner
     void findSections(const QCString &input,const Definition *d,
         const QCString &fileName);

src/doctokenizer.l

@@ -2227,4 +2227,19 @@ void DocTokenizer::popState()
   yyextra->stateStack.pop();
 }
 
+int DocTokenizer::getState()
+{
+  yyscan_t yyscanner = p->yyscanner;
+  struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
+  return YYSTATE;
+}
+
+void DocTokenizer::setState(int newState)
+{
+  yyscan_t yyscanner = p->yyscanner;
+  struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
+  BEGIN(newState);
+}
+
+
 #include "doctokenizer.l.h"