Comment BinaryRef::Data.

Also, state an invariant.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@183348 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/Object/YAML.h b/include/llvm/Object/YAML.h
index 5e658f13d02d48c7c1b103e2a076d23707c2f513..e6f1da1e1d4253917c57f11847a9c35d490069ad 100644 (file)
--- a/include/llvm/Object/YAML.h
+++ b/include/llvm/Object/YAML.h
@@ -24,6 +24,8 @@ namespace yaml {
 /// In an object file this is just a binary blob. In an yaml file it is an hex
 /// string. Using this avoid having to allocate temporary strings.
 class BinaryRef {
+  /// \brief Either raw binary data, or a string of hex bytes (must always
+  /// be an even number of characters).
   ArrayRef<uint8_t> Data;
   bool isBinary;