[llvm] r278186 - [OptDiag] Add class Doxygen comment

[Adam Nemet via llvm-commits]

Author: anemet
Date: Tue Aug  9 19:44:56 2016
New Revision: 278186

URL: http://llvm.org/viewvc/llvm-project?rev=278186&view=rev
Log:
[OptDiag] Add class Doxygen comment

This was requested in D22694.

Modified:
    llvm/trunk/include/llvm/Analysis/OptimizationDiagnosticInfo.h

Modified: llvm/trunk/include/llvm/Analysis/OptimizationDiagnosticInfo.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Analysis/OptimizationDiagnosticInfo.h?rev=278186&r1=278185&r2=278186&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Analysis/OptimizationDiagnosticInfo.h (original)
+++ llvm/trunk/include/llvm/Analysis/OptimizationDiagnosticInfo.h Tue Aug  9 19:44:56 2016
@@ -29,6 +29,12 @@ class Pass;
 class Twine;
 class Value;
 
+/// The optimization diagnostic interface.
+///
+/// It allows reporting when optimizations are performed and when they are not
+/// along with the reasons for it.  Hotness information of the corresponding
+/// code region can be included in the remark if DiagnosticHotnessRequested is
+/// enabled in the LLVM context.
 class OptimizationRemarkEmitter {
 public:
   OptimizationRemarkEmitter(Function *F, BlockFrequencyInfo *BFI)