[analyzer] Fix wrong parameter name in printFormattedEntry

[nullptr.cpp]

Summary

Function printFormattedEntry has declaration:

static void printFormattedEntry(
    llvm::raw_ostream &Out,
    std::pair<StringRef, StringRef> EntryDescPair,
    size_t EntryWidth, size_t InitialPad, size_t MinLineWidth = 0);

But in its definition:

void AnalyzerOptions::printFormattedEntry(
    llvm::raw_ostream &Out,
    std::pair<StringRef, StringRef> EntryDescPair,
    size_t InitialPad, size_t EntryWidth, size_t MinLineWidth) {

EntryWidth and InitialPad have different position.

The definition code and all printFormattedEntry's usages use the same
position as the definition, so fix the wrong parameter name in declaration.
Also fix some errors in the comments and make the comments clearer.

[Szelethus]

Nice, thank you! Did you stumble across this, or found it with a tool?

[nullptr.cpp]

In D86691#2241401, @Szelethus wrote:

Nice, thank you! Did you stumble across this, or found it with a tool?

I just happened to see these code:-).
Maybe we should write a checker to check this situation? I will start doing this!

BTW, I don't have commit access, can you help commit this and D86334? Thanks!

[martong]

In D86691#2241604, @nullptr.cpp wrote:

In D86691#2241401, @Szelethus wrote:

Nice, thank you! Did you stumble across this, or found it with a tool?

I just happened to see these code:-).
Maybe we should write a checker to check this situation? I will start doing this!

Good idea! And thanks for the fix! :)

[nullptr.cpp]

@Szelethus @martong
Sorry to interrupt, I don't have commit access, can you help commit this and D86334?
Yang Fan <[e-mail]>
Thanks!

[martong]

In D86691#2242004, @nullptr.cpp wrote:

@Szelethus @martong
Sorry to interrupt, I don't have commit access, can you help commit this and D86334?
Yang Fan <[e-mail]>
Thanks!

Yep, no problem, I'll commit them tomorrow, first thing! Thanks again!

[nullptr.cpp]

In D86691#2241886, @martong wrote:

In D86691#2241604, @nullptr.cpp wrote:

In D86691#2241401, @Szelethus wrote:

Nice, thank you! Did you stumble across this, or found it with a tool?

I just happened to see these code:-).
Maybe we should write a checker to check this situation? I will start doing this!

Good idea! And thanks for the fix! :)

There already have a clang-tidy checker can check this situation.
See readability-inconsistent-declaration-parameter-name for more information.

clang/include/clang/StaticAnalyzer/Core/AnalyzerOptions.h

public:
   /// contain statically linked but non-generated packages and plugin packages!
   static std::vector<StringRef>
   getRegisteredPackages(bool IncludeExperimental = false);
 
   /// Convenience function for printing options or checkers and their
   /// description in a formatted manner. If \p MinLineWidth is set to 0, no line
   /// breaks are introduced for the description.
   ///
-  /// Format, depending whether the option name's length is less then
-  /// \p OptionWidth:
+  /// Format, depending whether the option name's length is less than
+  /// \p EntryWidth:
   ///
   ///   <padding>EntryName<padding>Description
   ///   <---------padding--------->Description
   ///   <---------padding--------->Description
   ///
-  ///   <padding>VeryVeryLongOptionName
+  ///   <padding>VeryVeryLongEntryName
   ///   <---------padding--------->Description
   ///   <---------padding--------->Description
-  ///   ^~~~~~~~ InitialPad
-  ///   ^~~~~~~~~~~~~~~~~~~~~~~~~~ EntryWidth
+  ///   ^~~~~~~~~InitialPad
+  ///            ^~~~~~~~~~~~~~~~~~EntryWidth
   ///   ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~MinLineWidth
-  static void printFormattedEntry(
-      llvm::raw_ostream &Out,
+  static void printFormattedEntry(llvm::raw_ostream &Out,
                                   std::pair<StringRef, StringRef> EntryDescPair,
-      size_t EntryWidth, size_t InitialPad, size_t MinLineWidth = 0);
+                                  size_t InitialPad, size_t EntryWidth,
+                                  size_t MinLineWidth = 0);
 
   /// Pairs of checker/package name and enable/disable.
   std::vector<std::pair<std::string, bool>> CheckersAndPackages;
 
   /// Vector of checker/package names which will not emit warnings.
   std::vector<std::string> SilencedCheckersAndPackages;
 
   /// A key-value table of use-specified configuration values.

clang/lib/StaticAnalyzer/Core/AnalyzerOptions.cpp

void AnalyzerOptions::printFormattedEntry(
     std::pair<StringRef, StringRef> EntryDescPair,
     size_t InitialPad, size_t EntryWidth, size_t MinLineWidth) {
 
   llvm::formatted_raw_ostream FOut(Out);
 
   const size_t PadForDesc = InitialPad + EntryWidth;
 
   FOut.PadToColumn(InitialPad) << EntryDescPair.first;
-  // If the buffer's length is greater then PadForDesc, print a newline.
+  // If the buffer's length is greater than PadForDesc, print a newline.
   if (FOut.getColumn() > PadForDesc)
     FOut << '\n';
 
   FOut.PadToColumn(PadForDesc);
 
   if (MinLineWidth == 0) {
     FOut << EntryDescPair.second;
     return;