Skip to content

Releases: evaera/moonwave

Moonwave v0.3.5

27 Apr 19:56
Compare
Choose a tag to compare

What's Changed

  • Fixed String singletons throwing errors if initialized in Types #112
  • Fixed broken links by @leoyulee in #106
  • Fix typo "paramter" --> "parameter" in Types.md by @aku-e in #109
  • Don't add members that have the @ignore tag to the table of contents by @aku-e in #108
  • Added reference to official docusaurus docs by @leoyulee in #113

New Contributors

Full Changelog: v0.3.4...v0.3.5

Moonwave v0.3.4

16 Jan 00:08
Compare
Choose a tag to compare
  • Add special display for methods named __call

Before:
image
After:
image

Full Changelog: v0.3.3...v0.3.4

Moonwave v0.3.3

04 Jan 22:22
Compare
Choose a tag to compare
  • Strip http basic auth schemes from git repo URL when automatically detected from .git/config file.

Full Changelog: v0.3.2...v0.3.3

Moonwave v0.3.2

30 Dec 01:23
Compare
Choose a tag to compare

Bug fixes

  • Fix auto link reference using improper base url
  • Fix auto sections feature with nested folders

Moonwave v0.3.1

28 Dec 01:52
Compare
Choose a tag to compare
  • Add short links in docs
    • You can use the [ClassName] short link syntax to link to classes from within doc comments.
    • You can use [ClassName:method] or [ClassName.member] to link directly to a member of another class
    • You can also link to Roblox classes, like [CFrame] or [Part].
  • Add autoSectionPath option for automatically generating section names from folders: https://upliftgames.github.io/moonwave/docs/Configuration#automatic-sections-from-folders
  • Fix bug with param names not being detected correctly when there is extra whitespace
  • Fix enums not being included in auto links

Full Changelog: v0.3.0...v0.3.1

Moonwave v0.3.0

27 Dec 06:02
Compare
Choose a tag to compare
  • Moonwave now automatically detects parameter and return types from Luau type annotations, so specifying @param and @return is only necessary if you want to specify a description.
    • Type argument of @param is now optional when using Luau type annotations: @param paramName -- description goes here
  • Breaking change: @param tags may no longer specify parameter names that do not actually appear on the function they are attached to.
  • Breaking change: All parameters of a function are required to be documented if the function is documented, either through Luau type annotations or use of the @param tag, one or both.
  • Free functions (local function name()) no longer require the use of @function if the doc comment is attached to it, only the use of @within.
  • Fix bug where private members were unintentionally present in Table of Contents even when Show Private wasn't checked
  • Automatically reinstall packages if node_modules corruption detected in build folder: this should fix the unknown command "docusaurus" error

Full Changelog: v0.2.16...v0.3.0

Moonwave v0.2.16

26 Dec 06:17
Compare
Choose a tag to compare
  • Improved type syntax highlighter to better support tables
    image
  • If a Type is only used in one function and has no description, it will now be embedded directly inside the one function that uses it
    image

Full Changelog: v0.2.15...v0.2.16

Moonwave v0.2.15

26 Dec 02:18
Compare
Choose a tag to compare
  • Images in API pages are now centered
  • Fix bug where API categories did not show up in Table of Contents
  • Allow doc comments inside nested scopes and above return statements
  • Ignore lines that are all dashes ------
  • Add @method tag as an alternative to @function
  • Fix error on API page redirect when there were no API pages

Full Changelog: v0.2.14...v0.2.15

Moonwave v0.2.14

08 Dec 23:10
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.2.13...v0.2.14

Moonwave v0.2.13

24 Nov 20:34
Compare
Choose a tag to compare

What's Changed

  • Fix footer configuration docs by @evaera in #90
  • Automatically link type names inside types by @RileyAbr in #73
  • TOC on docusaurus v8+ by @RileyAbr in #92
  • Fix the footer.links example in documentation by @aku-e in #91

New Contributors

  • @aku-e made their first contribution in #91

Full Changelog: v0.2.12...v0.2.13