1
0
mirror of https://github.com/TomHarte/CLK.git synced 2024-11-22 12:33:29 +00:00

Add documentation.

This commit is contained in:
Thomas Harte 2021-07-30 21:20:45 -04:00
parent 1bae4973bc
commit 5c1ac05170

View File

@ -9,4 +9,11 @@
#include "ROMMachine.hpp"
ROMMachine::ROMFetcher CSROMFetcher(ROM::Request *missing = nullptr);
BOOL CSInstallROM(NSURL *);
/// Loads the binary file located at @c url and then tests for whether it matches anything
/// known to the ROM catalogue. If so then a copy of the ROM will be retained where it
/// can later be found by the ROM fetcher returned by @c CSROMFetcher.
///
/// @returns @c true if the file was loaded successfully and matches something in
/// the library; @c false otherwise.
BOOL CSInstallROM(NSURL *url);