Merge pull request #116 from Gnimuc/changelog

Add a changelog and bump the version

Author: JamesWrigley

Project.toml

@@ -1,7 +1,7 @@
 name = "CImGui"
 uuid = "5d785b6c-b76f-510e-a07c-3070796c7e87"
 authors = ["Yupei Qi <[email protected]>"]
-version = "1.89.0"
+version = "1.89.1"
 
 [deps]
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"

docs/.gitignore

@@ -1,2 +1,3 @@
 build/
 site/
+src/changelog.md

docs/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 CImGui = "5d785b6c-b76f-510e-a07c-3070796c7e87"
+Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]

docs/make.jl

@@ -1,5 +1,15 @@
 using CImGui
 using Documenter
+import Changelog
+
+# Note that the changelog file is named `_changelog.md` so we can use
+# `changelog.md` as the generated name, which makes for a prettier URL.
+Changelog.generate(
+    Changelog.Documenter(),
+    joinpath(@__DIR__, "src/_changelog.md"),
+    joinpath(@__DIR__, "src/changelog.md"),
+    repo="Gnimuc/CImGui.jl"
+)
 
 makedocs(;
     modules=[CImGui],
@@ -12,8 +22,9 @@ makedocs(;
         size_threshold=400000
     ),
     pages=[
-       "Introduction" => "index.md",
-       "API Reference" => "api.md",
+        "Introduction" => "index.md",
+        "API Reference" => "api.md",
+        "Changelog" => "changelog.md"
     ]
 )
 

docs/src/_changelog.md

@@ -0,0 +1,15 @@
+```@meta
+CurrentModule = CImGui
+```
+
+# Changelog
+
+This documents notable changes in CImGui.jl. The format is based on [Keep a
+Changelog](https://keepachangelog.com).
+
+
+## [v1.89.1] - 2024-05-19
+
+### Fixed
+
+- Fixed the implementations of [SetScrollX()](@ref) and [SetScrollY()](@ref) ([#115]).

src/wrapper.jl

@@ -527,13 +527,13 @@ GetScrollMaxY() = igGetScrollMaxY()
 
 """
     SetScrollX(scroll_x)
-Set scrolling amount [0..GetScrollMaxX()].
+Set scrolling amount [0..[GetScrollMaxX()](@ref)].
 """
 SetScrollX(scroll_x) = igSetScrollX_Float(scroll_x)
 
 """
     SetScrollY(scroll_y)
-Set scrolling amount [0..GetScrollMaxY()].
+Set scrolling amount [0..[GetScrollMaxY()](@ref)].
 """
 SetScrollY(scroll_y) = igSetScrollY_Float(scroll_y)