Skip to content

Commit

Permalink
Add doc comments to PrebuiltLoaderProtocol
Browse files Browse the repository at this point in the history
  • Loading branch information
p-x9 committed Nov 9, 2024
1 parent 3929e4f commit c58aa5f
Showing 1 changed file with 17 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,32 @@
import Foundation

public protocol PrebuiltLoaderProtocol {
/// Address where this loader is located.
///
/// Slides after loading are not included.
var address: Int { get }

/// magic of loader starts
var magic: String? { get }
/// PrebuiltLoader vs JustInTimeLoader
var isPrebuilt: Bool { get }
var ref: LoaderRef { get }

/// path for target mach-o image
/// - Parameter cache: DyldCache to which `self` belongs
/// - Returns: path name
func path(in cache: DyldCache) -> String?
/// loader reference list of target 's dependencies
/// - Parameter cache: DyldCache to which `self` belongs
/// - Returns: sequence of loader reference
func dependentLoaderRefs(in cache: DyldCache) -> DataSequence<LoaderRef>?

/// path for target mach-o image
/// - Parameter cache: DyldCacheLoaded to which `self` belongs
/// - Returns: path name
func path(in cache: DyldCacheLoaded) -> String?
/// loader reference list of target 's dependencies
/// - Parameter cache: DyldCacheLoaded to which `self` belongs
/// - Returns: sequence of loader reference
func dependentLoaderRefs(in cache: DyldCacheLoaded) -> MemorySequence<LoaderRef>?
}

0 comments on commit c58aa5f

Please sign in to comment.