-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature: Add changelog support in the
#[since()]
macro
This commit introduces the ability to include changelogs directly in the `#[since()]` macro. For example: ```rust #[since(version = "0.1.0", change = "add new argument `a: u64`", change = "add T")] ``` Generates the following documentation line: ```rust /// Since: 0.1.0: add new argument `a: u64`; add T ``` Key updates: - Multiple `change` attributes are supported within the same `#[since()]` macro. - Changelogs are concatenated into a single documentation line. This enhancement makes it easier to document changes alongside version annotations.
- Loading branch information
1 parent
5127df0
commit eef79b3
Showing
9 changed files
with
50 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/// Since: 1.1.0, Date(2021-02-01): add Foo; add Bar; add Baz | ||
/// | ||
/// Since: 1.0.0, Date(2021-01-01): Added | ||
const A: i32 = 0; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
#[openraft_macros::since( | ||
version = "1.1.0", | ||
date = "2021-02-01", | ||
change = "add Foo", | ||
change = "add Bar", | ||
change = "add Baz" | ||
)] | ||
#[openraft_macros::since(version = "1.0.0", date = "2021-01-01", change = "Added")] | ||
const A: i32 = 0; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/// Since: 1.0.0: add Foo | ||
const A: i32 = 0; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
#[openraft_macros::since(version = "1.0.0", change = "add Foo")] | ||
const A: i32 = 0; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/// Since: 1.0.0, Date(2021-01-01): add Foo | ||
const A: i32 = 0; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
#[openraft_macros::since(version = "1.0.0", date = "2021-01-01", change = "add Foo")] | ||
const A: i32 = 0; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/// Since: 1.0.0, Date(2021-01-01): add Foo; add Bar; add Baz | ||
const A: i32 = 0; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
#[openraft_macros::since( | ||
version = "1.0.0", | ||
date = "2021-01-01", | ||
change = "add Foo", | ||
change = "add Bar", | ||
change = "add Baz" | ||
)] | ||
const A: i32 = 0; |