remove newlines between different include types.

Add brief descriptions of each header file's purpose as per
llvm/docs/CodingStandards.rst

Author: jasonmolenda

lldb/tools/yaml2macho-core/CoreSpec.cpp

@@ -7,10 +7,8 @@
 //===----------------------------------------------------------------------===//
 
 #include "CoreSpec.h"
-
 #include "llvm/BinaryFormat/MachO.h"
 #include "llvm/Support/YAMLTraits.h"
-
 #include <stdio.h>
 #include <string>
 

lldb/tools/yaml2macho-core/CoreSpec.h

@@ -5,6 +5,13 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
+///
+/// \file
+/// CoreSpec holds the internal representation of the data that will be
+/// written into the corefile.  Theads, register sets within threads, registers
+/// within register sets.  Block of memory.  Metadata about the CPU or binaries
+/// that were present.
+//===----------------------------------------------------------------------===//
 
 #ifndef YAML2MACHOCOREFILE_CORESPEC_H
 #define YAML2MACHOCOREFILE_CORESPEC_H

lldb/tools/yaml2macho-core/LCNoteWriter.cpp

@@ -5,16 +5,14 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
-#include "lldb/Utility/UUID.h"
 
 #include "LCNoteWriter.h"
 #include "Utility.h"
-
+#include "lldb/Utility/UUID.h"
+#include "llvm/BinaryFormat/MachO.h"
 #include <ctype.h>
 #include <stdlib.h>
 
-#include "llvm/BinaryFormat/MachO.h"
-
 void create_lc_note_binary_load_cmd(const CoreSpec &spec,
                                     std::vector<uint8_t> &cmds,
                                     const Binary &binary,

lldb/tools/yaml2macho-core/LCNoteWriter.h

@@ -5,6 +5,10 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
+/// \file
+/// Functions to add an LC_NOTE load command to the corefile's load commands,
+/// and supply the payload of that LC_NOTE separately.
+//===----------------------------------------------------------------------===//
 
 #ifndef YAML2MACHOCOREFILE_LCNOTEWRITER_H
 #define YAML2MACHOCOREFILE_LCNOTEWRITER_H

lldb/tools/yaml2macho-core/MemoryWriter.cpp

@@ -9,7 +9,6 @@
 #include "MemoryWriter.h"
 #include "CoreSpec.h"
 #include "Utility.h"
-
 #include "llvm/BinaryFormat/MachO.h"
 
 void create_lc_segment_cmd(const CoreSpec &spec, std::vector<uint8_t> &cmds,

lldb/tools/yaml2macho-core/MemoryWriter.h

@@ -5,6 +5,10 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
+/// \file
+/// Functions to emit the LC_SEGMENT load command, and to provide the bytes
+/// that appear later in the corefile.
+//===----------------------------------------------------------------------===//
 
 #ifndef YAML2MACHOCOREFILE_MEMORYWRITER_H
 #define YAML2MACHOCOREFILE_MEMORYWRITER_H

lldb/tools/yaml2macho-core/ThreadWriter.cpp

@@ -9,9 +9,7 @@
 #include "ThreadWriter.h"
 #include "CoreSpec.h"
 #include "Utility.h"
-
 #include "llvm/BinaryFormat/MachO.h"
-
 #include <algorithm>
 #include <stdio.h>
 

lldb/tools/yaml2macho-core/ThreadWriter.h

@@ -5,6 +5,11 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
+/// \file
+/// Functions to emit LC_THREAD bytes to the corefile's Mach-O load commands,
+/// specifying the threads, the register sets ("flavors") within those threads,
+/// and all of the registers within those register sets.
+//===----------------------------------------------------------------------===//
 
 #ifndef YAML2MACHOCOREFILE_THREADWRITER_H
 #define YAML2MACHOCOREFILE_THREADWRITER_H

lldb/tools/yaml2macho-core/yaml2macho.cpp

@@ -11,9 +11,7 @@
 #include "MemoryWriter.h"
 #include "ThreadWriter.h"
 #include "Utility.h"
-
 #include "llvm/BinaryFormat/MachO.h"
-
 #include <getopt.h>
 #include <stdio.h>
 #include <string>