[PATCH] D17476: [aa-eval] Enhance the comments to better describe the overview of why this pass exists.

[Chandler Carruth via llvm-commits]

chandlerc created this revision.
chandlerc added a reviewer: reames.
chandlerc added a subscriber: llvm-commits.
Herald added a subscriber: mcrosier.

This is based on feedback received when moving this comment from the source
file to a new header file.

http://reviews.llvm.org/D17476

Files:
  include/llvm/Analysis/AliasAnalysisEvaluator.h

Index: include/llvm/Analysis/AliasAnalysisEvaluator.h
===================================================================
--- include/llvm/Analysis/AliasAnalysisEvaluator.h
+++ include/llvm/Analysis/AliasAnalysisEvaluator.h
@@ -6,15 +6,20 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-//
-// This file implements a simple N^2 alias analysis accuracy evaluator.
-// Basically, for each function in the program, it simply queries to see how the
-// alias analysis implementation answers alias queries between each pair of
-// pointers in the function.
-//
-// This is inspired and adapted from code by: Naveen Neelakantam, Francesco
-// Spadini, and Wojciech Stryjewski.
-//
+/// \file
+/// 
+/// This file implements a simple N^2 alias analysis accuracy evaluator. The
+/// analysis result is a set of statistics of how many times the AA
+/// infrastructure provides each kind of alias result and mod/ref result when
+/// queried with all pairs of pointers in the function.
+///
+/// It can be used to evaluate a change in an alias analysis implementation,
+/// algorithm, or the AA pipeline infrastructure itself. It acts like a stable
+/// and easily tested consumer of all AA information exposed.
+///
+/// This is inspired and adapted from code by: Naveen Neelakantam, Francesco
+/// Spadini, and Wojciech Stryjewski.
+///
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_ANALYSIS_ALIASANALYSISEVALUATOR_H


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D17476.48574.patch
Type: text/x-patch
Size: 1544 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20160220/8de54ba3/attachment-0001.bin>