Skip to content

Commit

Permalink
Updates CHANGELOG for next versions.
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoFara committed Dec 29, 2023
1 parent f08d646 commit 246cdc4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
14 changes: 10 additions & 4 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ other versions come from the canonical LWT ("official" branch on Git).
For git tags, official releases are marked like "v1.0.0", while unofficial
ones are marked like "v1.0.0-fork".

## [Unreleased]

## 2.9.1-fork (December 29 2023)

### Added
### Added in 2.9.1-fork

* New tools for documentation:
* New JavaScript documentation with [JSDoc](https://jsdoc.app/)! You will find it under `docs/js/`.
* Better PHP documentation using [phpDocumentor](https://phpdoc.org/). The new documentation is at `docs/php/`.
* New constant `LWT_LANGUAGES_ARRAY`, that replaces `$langDefs` (in `inc/langdefs.php`).
Part of [#163](https://github.com/HugoFara/lwt/issues/163).

### Changed
### Changed in 2.9.1-fork

* PHP files header docblocks are expanded, notably with a PHP version, package and category name.
* Japanese number are now parsed by MeCab. Big thanks to
Expand All @@ -26,7 +28,7 @@ Part of [#163](https://github.com/HugoFara/lwt/issues/163).
* Patch update to the REST API to 0.1.1: requests on GET with empty payload were
resulting in error.

### Fixed
### Fixed in 2.9.1-fork

* Fixes [#113](https://github.com/HugoFara/lwt/issues/113): changing a language name
was making text-to-speech unusable and may prompt a warning.
Expand Down Expand Up @@ -58,12 +60,16 @@ resulting in broken path ([#161](https://github.com/HugoFara/lwt/issues/161)).
PR [#154](https://github.com/HugoFara/lwt/pull/154/files) by
[@ProgramComputer](https://github.com/ProgramComputer).

### Deprecated
### Deprecated in 2.9.1-fork

* PHP documentation using Doxygen (under `docs/html`) is now deprecated and will be removed in 3.0.0.
* Using `$langDefs` is deprecated in favor of `LWT_LANGUAGES_ARRAY` ([#163](https://github.com/HugoFara/lwt/issues/163)).
* Calling the global function `new_pos` to set audio position is deprecated. Please use `lwt_audio_controller.setPosition`.

### Full Changelog for 2.9.1-fork

* [2.9.0...2.9.1](https://github.com/HugoFara/lwt/compare/2.9.0...2.9.1)

## 2.9.0-fork (December 24 2023)

### Added in 2.9.0-fork
Expand Down
15 changes: 11 additions & 4 deletions docs/info.html
Original file line number Diff line number Diff line change
Expand Up @@ -2182,8 +2182,9 @@ <h2 id="CHANGELOG" name="CHANGELOG">▶ Changelog - <a href="#">[↑]</a></h2>
other versions come from the canonical LWT ("official" branch on Git).
For git tags, official releases are marked like "v1.0.0", while unofficial
ones are marked like "v1.0.0-fork".</p>
<h3>[Unreleased]</h3>
<h3>2.9.1-fork (December 29 2023)</h3>
<h4>Added</h4>
<h4>Added in 2.9.1-fork</h4>
<ul>
<li>New tools for documentation:
<ul>
Expand All @@ -2194,7 +2195,7 @@ <h4>Added</h4>
<li>New constant <code>LWT_LANGUAGES_ARRAY</code>, that replaces <code>$langDefs</code> (in <code>inc/langdefs.php</code>).
Part of <a href="https://github.com/HugoFara/lwt/issues/163">#163</a>.</li>
</ul>
<h4>Changed</h4>
<h4>Changed in 2.9.1-fork</h4>
<ul>
<li>PHP files header docblocks are expanded, notably with a PHP version, package and category name.</li>
<li>Japanese number are now parsed by MeCab. Big thanks to
Expand All @@ -2205,7 +2206,7 @@ <h4>Changed</h4>
<li>Patch update to the REST API to 0.1.1: requests on GET with empty payload were
resulting in error.</li>
</ul>
<h4>Fixed</h4>
<h4>Fixed in 2.9.1-fork</h4>
<ul>
<li>Fixes <a href="https://github.com/HugoFara/lwt/issues/113">#113</a>: changing a language name
was making text-to-speech unusable and may prompt a warning.</li>
Expand Down Expand Up @@ -2238,12 +2239,18 @@ <h4>Fixed</h4>
PR <a href="https://github.com/HugoFara/lwt/pull/154/files">#154</a> by
<a href="https://github.com/ProgramComputer">@ProgramComputer</a>.</li>
</ul>
<h4>Deprecated</h4>
<h4>Deprecated in 2.9.1-fork</h4>
<ul>
<li>PHP documentation using Doxygen (under <code>docs/html</code>) is now deprecated and will be removed in 3.0.0.</li>
<li>Using <code>$langDefs</code> is deprecated in favor of <code>LWT_LANGUAGES_ARRAY</code> (<a href="https://github.com/HugoFara/lwt/issues/163">#163</a>).</li>
<li>Calling the global function <code>new_pos</code> to set audio position is deprecated. Please use <code>lwt_audio_controller.setPosition</code>.</li>
</ul>
<h4>Full Changelog for 2.9.1-fork</h4>
<ul>
<li>
<a href="https://github.com/HugoFara/lwt/compare/2.9.0...2.9.1">2.9.0...2.9.1</a>
</li>
</ul>
<h3>2.9.0-fork (December 24 2023)</h3>
<h4>Added in 2.9.0-fork</h4>
<ul>
Expand Down

0 comments on commit 246cdc4

Please sign in to comment.