[PATCH] D24061: NFC fix doxygen comments

[Teresa Johnson via llvm-commits]

tejohnson added a comment.

LGTM with a couple of fixes noted below. Please split out the non-doxygen fixes from this patch and submit those as separate NFC changes (doesn't need to be reviewed further).



> Function.h:194
>  
> -  /// Set the entry count for this function.
> +  /// \breif Set the entry count for this function.
> +  /// Entry cound is the number of times function have been executed based on

s/breif/brief/
Also, I believe you need an empty line (also starting with ///) between the brief description and the detailed description.

> Function.h:195
> +  /// \breif Set the entry count for this function.
> +  /// Entry cound is the number of times function have been executed based on
> +  /// pgo data.

s/cound/count/
s/function have been/the function was/

> Function.h:199
>  
> -  /// Get the entry count for this function.
> +  /// \brief Get the entry count for this function.
> +  /// Entry cout is the number of times function have been executed based on

Needs line between brief and detailed

> Function.h:200
> +  /// \brief Get the entry count for this function.
> +  /// Entry cout is the number of times function have been executed based on
> +  /// pgo data.

s/cound/count/
s/function have been/the function was/

> ProfileCommon.h:57
>    ProfileSummaryBuilder(std::vector<uint32_t> Cutoffs)
> -      : DetailedSummaryCutoffs(std::move(Cutoffs)), TotalCount(0), MaxCount(0),
> -        MaxFunctionCount(0), NumCounts(0), NumFunctions(0) {}
> +      : DetailedSummaryCutoffs(std::move(Cutoffs)) {}
>    inline void addCount(uint64_t Count);

This is not a doxygen change, remove from this patch.

> ProfileCommon.h:61
>    void computeDetailedSummary();
> -  uint64_t TotalCount, MaxCount, MaxFunctionCount;
> -  uint32_t NumCounts, NumFunctions;
> +  uint64_t TotalCount = 0, MaxCount = 0, MaxFunctionCount = 0;
> +  uint32_t NumCounts = 0, NumFunctions = 0;

Ditto on these 2 lines

> ProfileCommon.h:70
>  class InstrProfSummaryBuilder final : public ProfileSummaryBuilder {
> -  uint64_t MaxInternalBlockCount;
> +  uint64_t MaxInternalBlockCount = 0;
>    inline void addEntryCount(uint64_t Count);

Ditto

> ProfileCommon.h:76
>    InstrProfSummaryBuilder(std::vector<uint32_t> Cutoffs)
> -      : ProfileSummaryBuilder(std::move(Cutoffs)), MaxInternalBlockCount(0) {}
> +      : ProfileSummaryBuilder(std::move(Cutoffs)) {}
>    void addRecord(const InstrProfRecord &);

Ditto.

> ProfileSummaryBuilder.cpp:64
> +  auto Iter = CountFrequencies.begin();
> +  const auto End = CountFrequencies.end();
>  

The changes to this file should also be submitted separately.

https://reviews.llvm.org/D24061