[cfe-dev] Please help to fix -Wdocumentation warninigs

[Dmitri Gribenko]

Hello,

Recently I've introduced a feature in Clang to parse documentation
comments and emit warnings for misuse of Doxygen commands in comments.

It would be good to have LLVM and Clang build cleanly with
-Wdocumentation.  There are only a few warnings left.  Please help
with the part of the code you are familiar with.

After we have zero warnings, we will enable -Wdocumentation by default.

Thank you for helping!

Dmitri

LLVM side:

llvm/include/llvm/MC/MCMachObjectWriter.h:226:14: warning: parameter
'StringIndexMap' not found in the function
      declaration [-Wdocumentation]
  /// \param StringIndexMap [out] - Map from symbol names to offsets in the

Clang side:

/home/grib/clang-scp/llvm/tools/clang/lib/Parse/ParseTemplate.cpp:175:12:
warning: parameter 'TemplateParams' not found in the function
      declaration [-Wdocumentation]
/// \param TemplateParams if non-NULL, the template parameter lists
           ^~~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/Parse/ParseTemplate.cpp:181:12:
warning: parameter 'TemplateLoc' not found in the function
      declaration [-Wdocumentation]
/// \param TemplateLoc when TemplateParams is NULL, the location of
           ^~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/Parse/ParseTemplate.cpp:181:12:
note: did you mean 'TemplateInfo'?
/// \param TemplateLoc when TemplateParams is NULL, the location of
           ^~~~~~~~~~~
           TemplateInfo
/home/grib/clang-scp/llvm/tools/clang/lib/Parse/ParseTemplate.cpp:842:12:
warning: parameter 'TemplateNameKind' not found in the function
      declaration [-Wdocumentation]
/// \param TemplateNameKind the kind of template that \p Template
           ^~~~~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/Parse/ParseTemplate.cpp:842:12:
note: did you mean 'TemplateName'?
/// \param TemplateNameKind the kind of template that \p Template
           ^~~~~~~~~~~~~~~~
           TemplateName


/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGClass.cpp:1099:12:
warning: parameter 'argBegin,argEnd' not found in the function
      declaration [-Wdocumentation]
/// \param argBegin,argEnd the arguments to evaluate and pass to the
           ^~~~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGClass.cpp:1126:12:
warning: parameter 'argBegin,argEnd' not found in the function
      declaration [-Wdocumentation]
/// \param argBegin,argEnd the arguments to evaluate and pass to the
           ^~~~~~~~~~~~~~~


/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGDecl.cpp:1434:12:
warning: parameter 'array' not found in the function declaration
      [-Wdocumentation]
/// \param array - a value of type elementType*
           ^~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGDecl.cpp:1435:12:
warning: parameter 'destructionKind' not found in the function
      declaration [-Wdocumentation]
/// \param destructionKind - the kind of destruction required
           ^~~~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGDecl.cpp:1436:12:
warning: parameter 'initializedElementCount' not found in the function
      declaration [-Wdocumentation]
/// \param initializedElementCount - a value of type size_t* holding
           ^~~~~~~~~~~~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGDecl.cpp:1453:12:
warning: parameter 'array' not found in the function declaration
      [-Wdocumentation]
/// \param array - a value of type elementType*
           ^~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGDecl.cpp:1454:12:
warning: parameter 'destructionKind' not found in the function
      declaration [-Wdocumentation]
/// \param destructionKind - the kind of destruction required
           ^~~~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/CGDecl.cpp:1455:12:
warning: parameter 'initializedElementCount' not found in the function
      declaration [-Wdocumentation]
/// \param initializedElementCount - a value of type size_t* holding
           ^~~~~~~~~~~~~~~~~~~~~~~

/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/../../include/clang/AST/VTTBuilder.h:106:14:
warning: parameter 'AddressPoints' not found in
      the function declaration [-Wdocumentation]
  /// \param AddressPoints - If the vtable is a construction vtable, this has
             ^~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/../../include/clang/AST/VTTBuilder.h:121:14:
warning: parameter 'AddressPoints' not found in
      the function declaration [-Wdocumentation]
  /// \param AddressPoints - If the vtable is a construction vtable, this has
             ^~~~~~~~~~~~~
/home/grib/clang-scp/llvm/tools/clang/lib/CodeGen/../../include/clang/AST/VTTBuilder.h:132:14:
warning: parameter 'AddressPoints' not found in
      the function declaration [-Wdocumentation]
  /// \param AddressPoints - If the vtable is a construction vtable, this has
             ^~~~~~~~~~~~~


/home/grib/clang-scp/llvm/tools/clang/lib/Sema/SemaTemplateDeduction.cpp:2999:12:
warning: parameter 'Name' not found in the function
      declaration [-Wdocumentation]
/// \param Name the name of the function being called. This is only significant
           ^~~~
/home/grib/clang-scp/llvm/tools/clang/lib/Sema/SemaTemplateDeduction.cpp:3996:12:
warning: parameter 'Index' not found in the function
      declaration [-Wdocumentation]
/// \param Index if non-NULL and the result of this function is non-nULL,
           ^~~~~


/home/grib/clang-scp/llvm/tools/clang/lib/Frontend/DiagnosticRenderer.cpp:232:12:
warning: parameter 'MacroSkipEnd' not found in the function
      declaration [-Wdocumentation]
/// \param MacroSkipEnd The depth to stop skipping macro expansions.
           ^~~~~~~~~~~~


-- 
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/