Skip to content

Commit 43c5acb

Browse files
committed
[gardening] Fix doxygen headers in ImageInspection files.
1 parent 534db2c commit 43c5acb

File tree

5 files changed

+32
-22
lines changed

5 files changed

+32
-22
lines changed

stdlib/public/runtime/ImageInspection.h

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@
99
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
1010
//
1111
//===----------------------------------------------------------------------===//
12-
//
13-
// This file includes routines that extract metadata from executable and
14-
// dynamic library image files generated by the Swift compiler. The
15-
// concrete implementations vary greatly by platform.
16-
//
12+
///
13+
/// \file
14+
///
15+
/// This file includes routines that extract metadata from executable and
16+
/// dynamic library image files generated by the Swift compiler. The concrete
17+
/// implementations vary greatly by platform.
18+
///
1719
//===----------------------------------------------------------------------===//
1820

1921
#ifndef SWIFT_RUNTIME_IMAGE_INSPECTION_H

stdlib/public/runtime/ImageInspectionELF.cpp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@
99
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
1010
//
1111
//===----------------------------------------------------------------------===//
12-
//
13-
// This file includes routines that interact with ld*.so on ELF-based platforms
14-
// to extract runtime metadata embedded in dynamically linked ELF images
15-
// generated by the Swift compiler.
16-
//
12+
///
13+
/// \file
14+
///
15+
/// This file includes routines that interact with ld*.so on ELF-based platforms
16+
/// to extract runtime metadata embedded in dynamically linked ELF images
17+
/// generated by the Swift compiler.
18+
///
1719
//===----------------------------------------------------------------------===//
1820

1921
#if defined(__ELF__) || defined(__ANDROID__)

stdlib/public/runtime/ImageInspectionELF.h

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@
99
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
1010
//
1111
//===----------------------------------------------------------------------===//
12-
//
13-
// ELF specific image inspection routines.
14-
//
12+
///
13+
/// \file
14+
///
15+
/// ELF specific image inspection routines.
16+
///
1517
//===----------------------------------------------------------------------===//
1618

1719
#ifndef SWIFT_RUNTIME_IMAGE_INSPECTION_ELF_H

stdlib/public/runtime/ImageInspectionInit.cpp

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@
99
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
1010
//
1111
//===----------------------------------------------------------------------===//
12-
//
13-
// This file along with swift_sections.S is prepended to each shared library
14-
// on an ELF target which contains protocol and metadata sections.
15-
//
12+
///
13+
/// \file
14+
///
15+
/// This file along with swift_sections.S is prepended to each shared library on
16+
/// an ELF target which contains protocol and metadata sections.
17+
///
1618
//===----------------------------------------------------------------------===//
1719

1820
#if defined(__ELF__) || defined(__ANDROID__)

stdlib/public/runtime/ImageInspectionMachO.cpp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@
99
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
1010
//
1111
//===----------------------------------------------------------------------===//
12-
//
13-
// This file includes routines that interact with dyld on Mach-O-based platforms
14-
// to extract runtime metadata embedded in images generated by the Swift
15-
// compiler.
16-
//
12+
///
13+
/// \file
14+
///
15+
/// This file includes routines that interact with dyld on Mach-O-based
16+
/// platforms to extract runtime metadata embedded in images generated by the
17+
/// Swift compiler.
18+
///
1719
//===----------------------------------------------------------------------===//
1820

1921
#if defined(__APPLE__) && defined(__MACH__)

0 commit comments

Comments
 (0)