Tightened the source code and README documentations in the library.

2026-09-18 12:45:39 +02:00
parent c9f887bacb
commit 9ae10590cc
97 changed files with 854 additions and 1142 deletions
@@ -1,11 +1,11 @@
 internal import CPlaydate

 extension Scoreboards {
-    /// A board belonging to the game.
+    /// One of the game's boards. Copied from `PDBoard`.
    public struct Board {
-        /// The board's identifier, used in the other scoreboard calls.
+        /// Passed as `boardID` to the other calls.
        public let boardID: String
-        /// The board's display name.
+        /// Display name.
        public let name: String

        init(_ board: PDBoard) {
@@ -1,11 +1,10 @@
 internal import CPlaydate

 extension Scoreboards {
-    /// The game's boards.
+    /// The game's boards. Copied from `PDBoardsList`.
    public struct BoardsList {
-        /// When the list was last updated, in seconds since the epoch.
+        /// Last update, in seconds since the epoch.
        public let lastUpdated: UInt32
-        /// The game's boards.
        public let boards: [Board]

        init(_ list: PDBoardsList) {
@@ -1,15 +1,14 @@
 internal import CPlaydate

 extension Scoreboards {
-    /// A score on a board.
+    /// A score on a board. Copied from `PDScore` or `PDListScore`.
    public struct Score {
-        /// The score's position on the board, starting at 1.
+        /// Position on the board, from 1.
        public let rank: UInt32
-        /// The score's value.
        public let value: UInt32
-        /// The name of the player who posted the score.
+        /// Name of the player who posted it.
        public let player: String
-        /// The board the score belongs to, when known.
+        /// `nil` if the C API gave none.
        public let boardID: String?

        init(_ score: PDScore) {
@@ -1,17 +1,16 @@
 internal import CPlaydate

 extension Scoreboards {
-    /// The scores on a board.
+    /// The scores on a board. Copied from `PDScoresList`.
    public struct ScoresList {
-        /// The board the scores belong to.
        public let boardID: String
-        /// When the list was last updated, in seconds since the epoch.
+        /// Last update, in seconds since the epoch.
        public let lastUpdated: UInt32
-        /// Whether the current player's score is included in the list.
+        /// Whether the current player's score is in the list.
        public let playerIncluded: Bool
-        /// The maximum number of scores the list can hold.
+        /// Maximum number of scores the list can hold.
        public let limit: UInt32
-        /// The scores, ordered by rank.
+        /// Ordered by rank.
        public let scores: [Score]

        init(_ list: PDScoresList) {