From 26aaddaa33ded1421187ccc5c7fddc6211435d64 Mon Sep 17 00:00:00 2001 From: Thomas Harte Date: Fri, 30 Jul 2021 21:34:22 -0400 Subject: [PATCH] Adds further documentation. --- OSBindings/Mac/Clock Signal/Machine/CSROMFetcher.hpp | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/OSBindings/Mac/Clock Signal/Machine/CSROMFetcher.hpp b/OSBindings/Mac/Clock Signal/Machine/CSROMFetcher.hpp index 38891b20b..1aff457f2 100644 --- a/OSBindings/Mac/Clock Signal/Machine/CSROMFetcher.hpp +++ b/OSBindings/Mac/Clock Signal/Machine/CSROMFetcher.hpp @@ -8,6 +8,11 @@ #include "ROMMachine.hpp" +/// @returns a ROM fetcher that will check: (i) this application's support directory; and +/// (ii) this application's bundle for any requested ROMs, in that order. +/// +/// All ROMs are found to be missing when the ROM fetcher is used will be added +/// to @c missing. ROMMachine::ROMFetcher CSROMFetcher(ROM::Request *missing = nullptr); /// Loads the binary file located at @c url and then tests for whether it matches anything