[flang-commits] [flang] ea35745 - [flang][NFC] Update comments.

[Eric Schweitz via flang-commits]

Author: Eric Schweitz
Date: 2021-02-05T10:54:58-08:00
New Revision: ea3574561020081d84459a6e8028b59ff3814000

URL: https://github.com/llvm/llvm-project/commit/ea3574561020081d84459a6e8028b59ff3814000
DIFF: https://github.com/llvm/llvm-project/commit/ea3574561020081d84459a6e8028b59ff3814000.diff

LOG: [flang][NFC] Update comments.

Differential Revision: https://reviews.llvm.org/D96152

Added: 
    

Modified: 
    flang/include/flang/Optimizer/Dialect/FIRType.h

Removed: 
    


################################################################################
diff  --git a/flang/include/flang/Optimizer/Dialect/FIRType.h b/flang/include/flang/Optimizer/Dialect/FIRType.h
index c6fa318acf78..c574665eaf78 100644
--- a/flang/include/flang/Optimizer/Dialect/FIRType.h
+++ b/flang/include/flang/Optimizer/Dialect/FIRType.h
@@ -5,6 +5,10 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
+//
+// Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
+//
+//===----------------------------------------------------------------------===//
 
 #ifndef OPTIMIZER_DIALECT_FIRTYPE_H
 #define OPTIMIZER_DIALECT_FIRTYPE_H
@@ -67,7 +71,9 @@ bool isa_fir_or_std_type(mlir::Type t);
 /// Is `t` a FIR dialect type that implies a memory (de)reference?
 bool isa_ref_type(mlir::Type t);
 
-/// Is `t` a type that is always trivially pass-by-reference?
+/// Is `t` a type that is always trivially pass-by-reference? Specifically, this
+/// is testing if `t` is a ReferenceType or any box type. Compare this to
+/// conformsWithPassByRef(), which includes pointers and allocatables.
 bool isa_passbyref_type(mlir::Type t);
 
 /// Is `t` a boxed type?