Skip to content

Commit

Permalink
Improve doc strings and add some missing ones.
Browse files Browse the repository at this point in the history
  • Loading branch information
brunchboy committed Aug 30, 2024
1 parent 48533d1 commit 643e2cb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
1 change: 0 additions & 1 deletion src/main/java/org/deepsymmetry/cratedigger/Database.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
/**
* <p>Parses rekordbox database export files, providing access to the information they contain.</p>
*/
@SuppressWarnings("ClassEscapesDefinedScope")
@API(status = API.Status.STABLE)
public class Database implements Closeable {

Expand Down
10 changes: 7 additions & 3 deletions src/main/kaitai/rekordbox_pdb.ksy
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ types:
type: u4
enum: page_type_ext
if: _root.is_ext
doc: |
Identifies the kind of rows that are found in this table from an exportExt.pdb file.
- id: empty_candidate
type: u4
- id: first_page
Expand Down Expand Up @@ -181,6 +183,8 @@ types:
type: u4
enum: page_type_ext
if: _root.is_ext
doc: |
Identifies the type of information stored in the rows of this page in an exportExt.pdb file.
- id: next_page
doc: |
Index of the next page containing this type of rows. Points past
Expand Down Expand Up @@ -372,7 +376,7 @@ types:
'page_type_ext::tags': tag_row
'page_type_ext::tag_tracks': tag_track_row
doc: |
The actual content of the row, as long as it is present.
The actual content of the row in an exportExt.pdb file, as long as it is present.
-webide-parse-mode: eager
-webide-representation: '{body.name.body.text}{body.title.body.text} ({body.id})'

Expand Down Expand Up @@ -902,7 +906,7 @@ types:

tag_row:
doc: |
A row that holds a tag name and its ID.
A row that holds a tag name and its ID (found only in exportExt.pdb files).
seq:
- type: u2
doc: |
Expand Down Expand Up @@ -950,7 +954,7 @@ types:
tag_track_row:
doc: |
A row that associates a track and a tag.
A row that associates a track and a tag (found only in exportExt.pdb files).
seq:
- type: u4
doc: |
Expand Down

0 comments on commit 643e2cb

Please sign in to comment.