swap parameter order of cmdName and cmdChar

doxygen · doxygen · commit 0dd5e8d03c7e · 2024-01-23T21:18:14.000+01:00
This way the order is also the printing order, which feels more natural.
diff --git a/src/docnode.cpp b/src/docnode.cpp
@@ -3178,7 +3178,7 @@ int DocPara::handleParamSection(const QCString &cmdName,
   return (rv!=TK_NEWPARA) ? rv : RetVal_OK;
 }
 
-void DocPara::handleCite(const QCString &cmdName, char cmdChar)
+void DocPara::handleCite(char cmdChar,const QCString &cmdName)
 {
   AUTO_TRACE();
   // get the argument of the cite command.
@@ -3210,7 +3210,7 @@ void DocPara::handleCite(const QCString &cmdName, char cmdChar)
   parser()->tokenizer.setStatePara();
 }
 
-void DocPara::handleEmoji(const QCString &cmdName, char cmdChar)
+void DocPara::handleEmoji(char cmdChar,const QCString &cmdName)
 {
   AUTO_TRACE();
   // get the argument of the emoji command.
@@ -3241,7 +3241,7 @@ void DocPara::handleEmoji(const QCString &cmdName, char cmdChar)
   parser()->tokenizer.setStatePara();
 }
 
-void DocPara::handleDoxyConfig(const QCString &cmdName, char cmdChar)
+void DocPara::handleDoxyConfig(char cmdChar,const QCString &cmdName)
 {
   // get the argument of the cite command.
   int tok=parser()->tokenizer.lex();
@@ -3360,7 +3360,7 @@ int DocPara::handleXRefItem()
   return retval;
 }
 
-void DocPara::handleShowDate(const QCString &cmdName, char cmdChar)
+void DocPara::handleShowDate(char cmdChar,const QCString &cmdName)
 {
   AUTO_TRACE();
   QCString fmt;
@@ -3431,7 +3431,7 @@ void DocPara::handleShowDate(const QCString &cmdName, char cmdChar)
   parser()->tokenizer.setStatePara();
 }
 
-void DocPara::handleILine(const QCString &cmdName, char cmdChar)
+void DocPara::handleILine(char cmdChar,const QCString &cmdName)
 {
   AUTO_TRACE();
   parser()->tokenizer.setStateILine();
@@ -3445,7 +3445,7 @@ void DocPara::handleILine(const QCString &cmdName, char cmdChar)
   parser()->tokenizer.setStatePara();
 }
 
-void DocPara::handleIFile(const QCString &cmdName, char cmdChar)
+void DocPara::handleIFile(char cmdChar,const QCString &cmdName)
 {
   AUTO_TRACE();
   int tok=parser()->tokenizer.lex();
@@ -3605,7 +3605,7 @@ void DocPara::handleLink(const QCString &cmdName,bool isJavaLink)
   }
 }
 
-void DocPara::handleRef(const QCString &cmdName,char cmdChar)
+void DocPara::handleRef(char cmdChar,const QCString &cmdName)
 {
   AUTO_TRACE("cmdName={}",cmdName);
   QCString saveCmdName = cmdName;
@@ -3731,7 +3731,7 @@ void DocPara::handleInclude(const QCString &cmdName,DocInclude::Type t)
   children().get_last<DocInclude>()->parse();
 }
 
-void DocPara::handleSection(const QCString &cmdName,char cmdChar)
+void DocPara::handleSection(char cmdChar,const QCString &cmdName)
 {
   AUTO_TRACE("cmdName={}",cmdName);
   QCString saveCmdName = cmdName;
@@ -3850,15 +3850,14 @@ void DocPara::handleInheritDoc()
 }
 
 
-int DocPara::handleCommand(const QCString &cmdName, char cmdChar)
+int DocPara::handleCommand(char cmdChar, const QCString &cmdName)
 {
   AUTO_TRACE("cmdName={}",cmdName);
   int retval = RetVal_OK;
   int cmdId = Mappers::cmdMapper->map(cmdName);
   switch (cmdId)
   {
     case CMD_UNKNOWN:
-      //std::string delimiterString(1, cmdChar)
       {
         std::string str{cmdChar};
         children().append<DocWord>(parser(),thisVariant(),str.c_str() + cmdName);
@@ -4003,25 +4002,25 @@ int DocPara::handleCommand(const QCString &cmdName, char cmdChar)
       break;
     case CMD_SECTION:
       {
-        handleSection(cmdName,cmdChar);
+        handleSection(cmdChar,cmdName);
         retval = RetVal_Section;
       }
       break;
     case CMD_SUBSECTION:
       {
-        handleSection(cmdName,cmdChar);
+        handleSection(cmdChar,cmdName);
         retval = RetVal_Subsection;
       }
       break;
     case CMD_SUBSUBSECTION:
       {
-        handleSection(cmdName,cmdChar);
+        handleSection(cmdChar,cmdName);
         retval = RetVal_Subsubsection;
       }
       break;
     case CMD_PARAGRAPH:
       {
-        handleSection(cmdName,cmdChar);
+        handleSection(cmdChar,cmdName);
         retval = RetVal_Paragraph;
       }
       break;
@@ -4454,17 +4453,17 @@ int DocPara::handleCommand(const QCString &cmdName, char cmdChar)
       handleLink(cmdName,TRUE);
       break;
     case CMD_CITE:
-      handleCite(cmdName,cmdChar);
+      handleCite(cmdChar,cmdName);
       break;
     case CMD_EMOJI:
-      handleEmoji(cmdName,cmdChar);
+      handleEmoji(cmdChar,cmdName);
       break;
     case CMD_DOXYCONFIG:
-      handleDoxyConfig(cmdName,cmdChar);
+      handleDoxyConfig(cmdChar,cmdName);
       break;
     case CMD_REF: // fall through
     case CMD_SUBPAGE:
-      handleRef(cmdName,cmdChar);
+      handleRef(cmdChar,cmdName);
       break;
     case CMD_SECREFLIST:
       {
@@ -4497,13 +4496,13 @@ int DocPara::handleCommand(const QCString &cmdName, char cmdChar)
       handleInheritDoc();
       break;
     case CMD_SHOWDATE:
-      handleShowDate(cmdName,cmdChar);
+      handleShowDate(cmdChar,cmdName);
       break;
     case CMD_ILINE:
-      handleILine(cmdName,cmdChar);
+      handleILine(cmdChar,cmdName);
       break;
     case CMD_IFILE:
-      handleIFile(cmdName,cmdChar);
+      handleIFile(cmdChar,cmdName);
       break;
     default:
       // we should not get here!
@@ -5421,7 +5420,7 @@ int DocPara::parse()
           }
 
           // handle the command
-          retval=handleCommand(parser()->context.token->name,TK_COMMAND_CHAR(tok));
+          retval=handleCommand(TK_COMMAND_CHAR(tok),parser()->context.token->name);
           AUTO_TRACE_ADD("handleCommand returns {}",DocTokenizer::retvalToString(retval));
 
           // check the return value
diff --git a/src/docnode.h b/src/docnode.h
@@ -1044,7 +1044,7 @@ class DocPara : public DocCompoundNode
     bool isFirst() const        { return m_isFirst; }
     bool isLast() const         { return m_isLast; }
 
-    int handleCommand(const QCString &cmdName,char cmdChar);
+    int handleCommand(char cmdChar,const QCString &cmdName);
     int handleHtmlStartTag(const QCString &tagName,const HtmlAttribList &tagHtmlAttribs);
     int handleHtmlEndTag(const QCString &tagName);
     int handleSimpleSection(DocSimpleSect::Type t,bool xmlContext=FALSE);
@@ -1054,16 +1054,16 @@ class DocPara : public DocCompoundNode
     template<class T> void handleFile(const QCString &cmdName);
     void handleInclude(const QCString &cmdName,DocInclude::Type t);
     void handleLink(const QCString &cmdName,bool isJavaLink);
-    void handleCite(const QCString &cmdName,char cmdChar);
-    void handleDoxyConfig(const QCString &cmdName,char cmdChar);
-    void handleEmoji(const QCString &cmdName,char cmdChar);
-    void handleRef(const QCString &cmdName,char cmdChar);
-    void handleSection(const QCString &cmdName,char cmdChar);
+    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();
-    void handleILine(const QCString &cmdName,char cmdChar);
-    void handleIFile(const QCString &cmdName,char cmdChar);
-    void handleShowDate(const QCString &cmdName,char cmdChar);
+    void handleILine(char cmdChar,const QCString &cmdName);
+    void handleIFile(char cmdChar,const QCString &cmdName);
+    void handleShowDate(char cmdChar,const QCString &cmdName);
     int handleStartCode();
     int handleHtmlHeader(const HtmlAttribList &tagHtmlAttribs,int level);
 

Original file line number	Diff line number	Diff line change
`@@ -3178,7 +3178,7 @@ int DocPara::handleParamSection(const QCString &cmdName,`
`3178`	`3178`	`return (rv!=TK_NEWPARA) ? rv : RetVal_OK;`
`3179`	`3179`	`}`
`3180`	`3180`
`3181`		`-void DocPara::handleCite(const QCString &cmdName, char cmdChar)`
	`3181`	`+void DocPara::handleCite(char cmdChar,const QCString &cmdName)`
`3182`	`3182`	`{`
`3183`	`3183`	`AUTO_TRACE();`
`3184`	`3184`	`// get the argument of the cite command.`
`@@ -3210,7 +3210,7 @@ void DocPara::handleCite(const QCString &cmdName, char cmdChar)`
`3210`	`3210`	`parser()->tokenizer.setStatePara();`
`3211`	`3211`	`}`
`3212`	`3212`
`3213`		`-void DocPara::handleEmoji(const QCString &cmdName, char cmdChar)`
	`3213`	`+void DocPara::handleEmoji(char cmdChar,const QCString &cmdName)`
`3214`	`3214`	`{`
`3215`	`3215`	`AUTO_TRACE();`
`3216`	`3216`	`// get the argument of the emoji command.`
`@@ -3241,7 +3241,7 @@ void DocPara::handleEmoji(const QCString &cmdName, char cmdChar)`
`3241`	`3241`	`parser()->tokenizer.setStatePara();`
`3242`	`3242`	`}`
`3243`	`3243`
`3244`		`-void DocPara::handleDoxyConfig(const QCString &cmdName, char cmdChar)`
	`3244`	`+void DocPara::handleDoxyConfig(char cmdChar,const QCString &cmdName)`
`3245`	`3245`	`{`
`3246`	`3246`	`// get the argument of the cite command.`
`3247`	`3247`	`int tok=parser()->tokenizer.lex();`
`@@ -3360,7 +3360,7 @@ int DocPara::handleXRefItem()`
`3360`	`3360`	`return retval;`
`3361`	`3361`	`}`
`3362`	`3362`
`3363`		`-void DocPara::handleShowDate(const QCString &cmdName, char cmdChar)`
	`3363`	`+void DocPara::handleShowDate(char cmdChar,const QCString &cmdName)`
`3364`	`3364`	`{`
`3365`	`3365`	`AUTO_TRACE();`
`3366`	`3366`	`QCString fmt;`
`@@ -3431,7 +3431,7 @@ void DocPara::handleShowDate(const QCString &cmdName, char cmdChar)`
`3431`	`3431`	`parser()->tokenizer.setStatePara();`
`3432`	`3432`	`}`
`3433`	`3433`
`3434`		`-void DocPara::handleILine(const QCString &cmdName, char cmdChar)`
	`3434`	`+void DocPara::handleILine(char cmdChar,const QCString &cmdName)`
`3435`	`3435`	`{`
`3436`	`3436`	`AUTO_TRACE();`
`3437`	`3437`	`parser()->tokenizer.setStateILine();`
`@@ -3445,7 +3445,7 @@ void DocPara::handleILine(const QCString &cmdName, char cmdChar)`
`3445`	`3445`	`parser()->tokenizer.setStatePara();`
`3446`	`3446`	`}`
`3447`	`3447`
`3448`		`-void DocPara::handleIFile(const QCString &cmdName, char cmdChar)`
	`3448`	`+void DocPara::handleIFile(char cmdChar,const QCString &cmdName)`
`3449`	`3449`	`{`
`3450`	`3450`	`AUTO_TRACE();`
`3451`	`3451`	`int tok=parser()->tokenizer.lex();`
`@@ -3605,7 +3605,7 @@ void DocPara::handleLink(const QCString &cmdName,bool isJavaLink)`
`3605`	`3605`	`}`
`3606`	`3606`	`}`
`3607`	`3607`
`3608`		`-void DocPara::handleRef(const QCString &cmdName,char cmdChar)`
	`3608`	`+void DocPara::handleRef(char cmdChar,const QCString &cmdName)`
`3609`	`3609`	`{`
`3610`	`3610`	`AUTO_TRACE("cmdName={}",cmdName);`
`3611`	`3611`	`QCString saveCmdName = cmdName;`
`@@ -3731,7 +3731,7 @@ void DocPara::handleInclude(const QCString &cmdName,DocInclude::Type t)`
`3731`	`3731`	`children().get_last<DocInclude>()->parse();`
`3732`	`3732`	`}`
`3733`	`3733`
`3734`		`-void DocPara::handleSection(const QCString &cmdName,char cmdChar)`
	`3734`	`+void DocPara::handleSection(char cmdChar,const QCString &cmdName)`
`3735`	`3735`	`{`
`3736`	`3736`	`AUTO_TRACE("cmdName={}",cmdName);`
`3737`	`3737`	`QCString saveCmdName = cmdName;`
`@@ -3850,15 +3850,14 @@ void DocPara::handleInheritDoc()`
`3850`	`3850`	`}`
`3851`	`3851`
`3852`	`3852`
`3853`		`-int DocPara::handleCommand(const QCString &cmdName, char cmdChar)`
	`3853`	`+int DocPara::handleCommand(char cmdChar, const QCString &cmdName)`
`3854`	`3854`	`{`
`3855`	`3855`	`AUTO_TRACE("cmdName={}",cmdName);`
`3856`	`3856`	`int retval = RetVal_OK;`
`3857`	`3857`	`int cmdId = Mappers::cmdMapper->map(cmdName);`
`3858`	`3858`	`switch (cmdId)`
`3859`	`3859`	`{`
`3860`	`3860`	`case CMD_UNKNOWN:`
`3861`		`- //std::string delimiterString(1, cmdChar)`
`3862`	`3861`	`{`
`3863`	`3862`	`std::string str{cmdChar};`
`3864`	`3863`	`children().append<DocWord>(parser(),thisVariant(),str.c_str() + cmdName);`
`@@ -4003,25 +4002,25 @@ int DocPara::handleCommand(const QCString &cmdName, char cmdChar)`
`4003`	`4002`	`break;`
`4004`	`4003`	`case CMD_SECTION:`
`4005`	`4004`	`{`
`4006`		`- handleSection(cmdName,cmdChar);`
	`4005`	`+ handleSection(cmdChar,cmdName);`
`4007`	`4006`	`retval = RetVal_Section;`
`4008`	`4007`	`}`
`4009`	`4008`	`break;`
`4010`	`4009`	`case CMD_SUBSECTION:`
`4011`	`4010`	`{`
`4012`		`- handleSection(cmdName,cmdChar);`
	`4011`	`+ handleSection(cmdChar,cmdName);`
`4013`	`4012`	`retval = RetVal_Subsection;`
`4014`	`4013`	`}`
`4015`	`4014`	`break;`
`4016`	`4015`	`case CMD_SUBSUBSECTION:`
`4017`	`4016`	`{`
`4018`		`- handleSection(cmdName,cmdChar);`
	`4017`	`+ handleSection(cmdChar,cmdName);`
`4019`	`4018`	`retval = RetVal_Subsubsection;`
`4020`	`4019`	`}`
`4021`	`4020`	`break;`
`4022`	`4021`	`case CMD_PARAGRAPH:`
`4023`	`4022`	`{`
`4024`		`- handleSection(cmdName,cmdChar);`
	`4023`	`+ handleSection(cmdChar,cmdName);`
`4025`	`4024`	`retval = RetVal_Paragraph;`
`4026`	`4025`	`}`
`4027`	`4026`	`break;`
`@@ -4454,17 +4453,17 @@ int DocPara::handleCommand(const QCString &cmdName, char cmdChar)`
`4454`	`4453`	`handleLink(cmdName,TRUE);`
`4455`	`4454`	`break;`
`4456`	`4455`	`case CMD_CITE:`
`4457`		`- handleCite(cmdName,cmdChar);`
	`4456`	`+ handleCite(cmdChar,cmdName);`
`4458`	`4457`	`break;`
`4459`	`4458`	`case CMD_EMOJI:`
`4460`		`- handleEmoji(cmdName,cmdChar);`
	`4459`	`+ handleEmoji(cmdChar,cmdName);`
`4461`	`4460`	`break;`
`4462`	`4461`	`case CMD_DOXYCONFIG:`
`4463`		`- handleDoxyConfig(cmdName,cmdChar);`
	`4462`	`+ handleDoxyConfig(cmdChar,cmdName);`
`4464`	`4463`	`break;`
`4465`	`4464`	`case CMD_REF: // fall through`
`4466`	`4465`	`case CMD_SUBPAGE:`
`4467`		`- handleRef(cmdName,cmdChar);`
	`4466`	`+ handleRef(cmdChar,cmdName);`
`4468`	`4467`	`break;`
`4469`	`4468`	`case CMD_SECREFLIST:`
`4470`	`4469`	`{`
`@@ -4497,13 +4496,13 @@ int DocPara::handleCommand(const QCString &cmdName, char cmdChar)`
`4497`	`4496`	`handleInheritDoc();`
`4498`	`4497`	`break;`
`4499`	`4498`	`case CMD_SHOWDATE:`
`4500`		`- handleShowDate(cmdName,cmdChar);`
	`4499`	`+ handleShowDate(cmdChar,cmdName);`
`4501`	`4500`	`break;`
`4502`	`4501`	`case CMD_ILINE:`
`4503`		`- handleILine(cmdName,cmdChar);`
	`4502`	`+ handleILine(cmdChar,cmdName);`
`4504`	`4503`	`break;`
`4505`	`4504`	`case CMD_IFILE:`
`4506`		`- handleIFile(cmdName,cmdChar);`
	`4505`	`+ handleIFile(cmdChar,cmdName);`
`4507`	`4506`	`break;`
`4508`	`4507`	`default:`
`4509`	`4508`	`// we should not get here!`
`@@ -5421,7 +5420,7 @@ int DocPara::parse()`
`5421`	`5420`	`}`
`5422`	`5421`
`5423`	`5422`	`// handle the command`
`5424`		`- retval=handleCommand(parser()->context.token->name,TK_COMMAND_CHAR(tok));`
	`5423`	`+ retval=handleCommand(TK_COMMAND_CHAR(tok),parser()->context.token->name);`
`5425`	`5424`	`AUTO_TRACE_ADD("handleCommand returns {}",DocTokenizer::retvalToString(retval));`
`5426`	`5425`
`5427`	`5426`	`// check the return value`