Improve warning location for undocumented parameters/return types

Warning could point at a header while the documentation block with the problem was located in a source file.
doxygen · Dec 26, 2021 · 2b4e688 · 2b4e688
1 parent ababe4c
commit 2b4e688
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/src/docparser.cpp b/src/docparser.cpp
@@ -513,8 +513,8 @@ void DocParser::checkUnOrMultipleDocumentedParams()
           }
           else if (count>1 && Config_getBool(WARN_IF_DOC_ERROR))
           {
-            warn_doc_error(context.memberDef->getDefFileName(),
-                           context.memberDef->getDefLine(),
+            warn_doc_error(context.memberDef->docFile(),
+                           context.memberDef->docLine(),
                            "%s",
                            qPrint("argument '" + aName +
                            "' from the argument list of " +
@@ -541,8 +541,8 @@ void DocParser::checkUnOrMultipleDocumentedParams()
           first=FALSE;
           errMsg+="  parameter '"+argName+"'";
         }
-        warn_incomplete_doc(context.memberDef->getDefFileName(),
-                            context.memberDef->getDefLine(),
+        warn_incomplete_doc(context.memberDef->docFile(),
+                            context.memberDef->docLine(),
                             "%s",
                             qPrint(substitute(errMsg,"%","%%")));
       }

diff --git a/src/memberdef.cpp b/src/memberdef.cpp
@@ -4006,7 +4006,7 @@ void MemberDefImpl::detectUndocumentedParams(bool hasParamCommand,bool hasReturn
           )
   {
 
-    warn_doc_error(getDefFileName(),getDefLine(),"documented empty return type of %s",
+    warn_doc_error(docFile(),docLine(),"documented empty return type of %s",
                           qPrint(qualifiedName()));
   }
   else if ( // see if return needs to documented
@@ -4034,14 +4034,14 @@ void MemberDefImpl::warnIfUndocumentedParams() const
     QCString returnType = typeString();
     if (!m_impl->hasDocumentedParams)
     {
-      warn_doc_error(getDefFileName(),getDefLine(),
+      warn_doc_error(docFile(),docLine(),
           "parameters of member %s are not (all) documented",
           qPrint(qualifiedName()));
     }
     if (!m_impl->hasDocumentedReturnType &&
         hasDocumentation() && !returnType.isEmpty())
     {
-      warn_doc_error(getDefFileName(),getDefLine(),
+      warn_doc_error(docFile(),docLine(),
           "return type of member %s is not documented",
           qPrint(qualifiedName()));
     }