Merge pull request swiftlang#9208 from gottesmm/more_small_gardening

Author: swift-ci

stdlib/public/runtime/ImageInspection.h

@@ -9,27 +9,30 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-//
-// This file includes routines that extract metadata from executable and
-// dynamic library image files generated by the Swift compiler. The
-// concrete implementations vary greatly by platform.
-//
+///
+/// \file
+///
+/// This file includes routines that extract metadata from executable and
+/// dynamic library image files generated by the Swift compiler. The concrete
+/// implementations vary greatly by platform.
+///
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_RUNTIME_IMAGE_INSPECTION_H
-#define SWIFT_RUNTIME_IMAGE_INSPECTION_H
+#ifndef SWIFT_RUNTIME_IMAGEINSPECTION_H
+#define SWIFT_RUNTIME_IMAGEINSPECTION_H
 
 #include "ImageInspectionELF.h"
 #include <cstdint>
 
 namespace swift {
-  // This is a platform independent version of Dl_info from dlfcn.h
-  struct SymbolInfo {
-    const char *fileName;
-    void *baseAddress;
-    const char *symbolName;
-    void *symbolAddress;
-  };
+
+/// This is a platform independent version of Dl_info from dlfcn.h
+struct SymbolInfo {
+  const char *fileName;
+  void *baseAddress;
+  const char *symbolName;
+  void *symbolAddress;
+};
 
 /// Load the metadata from the image necessary to find a type's
 /// protocol conformance.
@@ -46,6 +49,7 @@ void addImageTypeMetadataRecordBlockCallback(const void *start,
                                              uintptr_t size);
 
 int lookupSymbol(const void *address, SymbolInfo *info);
+
 } // end namespace swift
 
-#endif // SWIFT_RUNTIME_IMAGE_INSPECTION_H
+#endif

stdlib/public/runtime/ImageInspectionELF.cpp

@@ -9,11 +9,13 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-//
-// This file includes routines that interact with ld*.so on ELF-based platforms
-// to extract runtime metadata embedded in dynamically linked ELF images
-// generated by the Swift compiler.
-//
+///
+/// \file
+///
+/// This file includes routines that interact with ld*.so on ELF-based platforms
+/// to extract runtime metadata embedded in dynamically linked ELF images
+/// generated by the Swift compiler.
+///
 //===----------------------------------------------------------------------===//
 
 #if defined(__ELF__) || defined(__ANDROID__)

stdlib/public/runtime/ImageInspectionELF.h

@@ -9,13 +9,15 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-//
-// ELF specific image inspection routines.
-//
+///
+/// \file
+///
+/// ELF specific image inspection routines.
+///
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_RUNTIME_IMAGE_INSPECTION_ELF_H
-#define SWIFT_RUNTIME_IMAGE_INSPECTION_ELF_H
+#ifndef SWIFT_RUNTIME_IMAGEINSPECTIONELF_H
+#define SWIFT_RUNTIME_IMAGEINSPECTIONELF_H
 
 #if defined(__ELF__) || defined(__ANDROID__)
 

stdlib/public/runtime/ImageInspectionInit.cpp

@@ -9,10 +9,12 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-//
-// This file along with swift_sections.S is prepended to each shared library
-// on an ELF target which contains protocol and metadata sections.
-//
+///
+/// \file
+///
+/// This file along with swift_sections.S is prepended to each shared library on
+/// an ELF target which contains protocol and metadata sections.
+///
 //===----------------------------------------------------------------------===//
 
 #if defined(__ELF__) || defined(__ANDROID__)

stdlib/public/runtime/ImageInspectionMachO.cpp

@@ -9,11 +9,13 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-//
-// This file includes routines that interact with dyld on Mach-O-based platforms
-// to extract runtime metadata embedded in images generated by the Swift
-// compiler.
-//
+///
+/// \file
+///
+/// This file includes routines that interact with dyld on Mach-O-based
+/// platforms to extract runtime metadata embedded in images generated by the
+/// Swift compiler.
+///
 //===----------------------------------------------------------------------===//
 
 #if defined(__APPLE__) && defined(__MACH__)