Skip to content

Commit

Permalink
fix comments
Browse files Browse the repository at this point in the history
  • Loading branch information
rpatters1 committed Oct 18, 2024
1 parent 4d17455 commit e84122b
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions src/library/enigmaxml.lua
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,11 @@ end
--[[
% extract_enigmaxml
EnigmaXML is the underlying file format of a Finale `.musx` file. It is undocumented
by MakeMusic and must be extracted from the `.musx` file. There is an effort to document
it underway at the [EnigmaXML Documentation](https://github.com/finale-lua/ziputils-documentation)
repository.
This function extracts the EnigmaXML buffer from a `.musx` file. Note that it does not work with Finale's
older `.mus` format.
@ filepath (string) utf8-encoded file path to a `.musx` file.
: (string) utf8-encoded buffer of xml data containing the EnigmaXml extracted from the `.musx`.
: (string) buffer of EnigmaXml data extracted from the `.musx`. (The xml declaration specifies the encoding, but expect it to be utf8.)
]]
function enigmaxml.extract_enigmaxml(filepath)
local not_supported_message
Expand All @@ -67,7 +62,7 @@ function enigmaxml.extract_enigmaxml(filepath)
end

-- Steps to extract:
-- Unzip the `.musx` (which is `.zip` in disguise)
-- Unzip the `.musx` (which is a `.zip` archive in disguise)
-- Run the `score.dat` file through `crypt_enigmaxml_buffer` to get a gzip archive of the EnigmaXML file.
-- Gunzip the extracted EnigmaXML gzip archive into a string and return it.

Expand Down

0 comments on commit e84122b

Please sign in to comment.