Skip to content

Commit d3c79cf

Browse files
author
lsleonard
committed
Udate release notes in header files
1 parent 2a9fb94 commit d3c79cf

File tree

2 files changed

+44
-13
lines changed

2 files changed

+44
-13
lines changed

td512.h

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,30 @@
1414
You should have received a copy of the GNU General Public License
1515
along with this program. If not, see <https://www.gnu.org/licenses/>.//
1616
*/
17-
// Notes for version 1.1:
18-
/* 1. Main program reads a file into memory that is compressed by
17+
// Notes for version 1.1.0:
18+
/*
19+
1. Main program reads a file into memory that is compressed by
1920
calling td512 repeatedly. When complete, the compressed data is
2021
written to a file and read for decompression by calling td512d.
2122
td512 filename [loopCount]]
2223
filename is required argument 1.
2324
loopCount is optional argument 2 (default: 1). Looping is performed over the entire input file.
24-
25-
26-
*/
25+
*/
26+
// Notes for version 1.1.1:
27+
/*
28+
1. Updated some descriptive comments.
29+
*/
30+
// Notes for version 1.1.2:
31+
/*
32+
1. Moved 7-bit mode defines to td64.h because they are used
33+
outside of the 7-bit mode.
34+
2. When fewer than minimum values to use 7-bit mode of 16, don't
35+
accumulate high bit when reasonable. Main loop keeps this in because
36+
time required is minimal.
37+
3. When fewer than 24 input values, but greater than or equal to minimum
38+
values of 16 to use 7-bit mode, use 6% as minimum compression for
39+
compression modes used prior to 7-bit mode.
40+
*/
2741

2842
#ifndef td512_h
2943
#define td512_h

td64.h

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,31 @@
1515
You should have received a copy of the GNU General Public License
1616
along with this program. If not, see <https://www.gnu.org/licenses/>.//
1717
*/
18-
// Notes for version 1.1:
19-
/* 1. Tiny data compression integrates several compression modes: fixed
20-
bit, text mode, single value, string mode, and 7-bit encoding and
21-
decoding. td64 returns the number of compressed bytes or 0 if
22-
compression failed or a negative value if an error occurred. Values
23-
are returned only if compression succeeds. Decoding of the td64 values
24-
requires the caller to supply the number of original bytes.
25-
*/
18+
// Notes for version 1.1.0:
19+
/*
20+
1. Main program reads a file into memory that is compressed by
21+
calling td512 repeatedly. When complete, the compressed data is
22+
written to a file and read for decompression by calling td512d.
23+
td512 filename [loopCount]]
24+
filename is required argument 1.
25+
loopCount is optional argument 2 (default: 1). Looping is performed over the entire input file.
26+
*/
27+
// Notes for version 1.1.1:
28+
/*
29+
1. Updated some descriptive comments.
30+
*/
31+
// Notes for version 1.1.2:
32+
/*
33+
1. Moved 7-bit mode defines to td64.h because they are used
34+
outside of the 7-bit mode.
35+
2. When fewer than minimum values to use 7-bit mode of 16, don't
36+
accumulate high bit when reasonable. Main loop keeps this in because
37+
time required is minimal.
38+
3. When fewer than 24 input values, but greater than or equal to minimum
39+
values of 16 to use 7-bit mode, use 6% as minimum compression for
40+
compression modes used prior to 7-bit mode.
41+
*/
42+
2643
#ifndef td64_h
2744
#define td64_h
2845

0 commit comments

Comments
 (0)