r255099 - clang-format: Improve documentation of AlignOperands.

[Daniel Jasper via cfe-commits]

Author: djasper
Date: Wed Dec  9 01:56:52 2015
New Revision: 255099

URL: http://llvm.org/viewvc/llvm-project?rev=255099&view=rev
Log:
clang-format: Improve documentation of AlignOperands.

Modified:
    cfe/trunk/include/clang/Format/Format.h

Modified: cfe/trunk/include/clang/Format/Format.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Format/Format.h?rev=255099&r1=255098&r2=255099&view=diff
==============================================================================
--- cfe/trunk/include/clang/Format/Format.h (original)
+++ cfe/trunk/include/clang/Format/Format.h Wed Dec  9 01:56:52 2015
@@ -100,6 +100,13 @@ struct FormatStyle {
 
   /// \brief If \c true, horizontally align operands of binary and ternary
   /// expressions.
+  ///
+  /// Specifically, this aligns operands of a single expression that needs to be
+  /// split over multiple lines, e.g.:
+  /// \code
+  ///   int aaa = bbbbbbbbbbbbbbb +
+  ///             ccccccccccccccc;
+  /// \endcode
   bool AlignOperands;
 
   /// \brief If \c true, aligns trailing comments.