doc: Use the conventional comment syntax

[Muhammad-Owais-Warsi]

Description

Changed the comments syntax from /* */ to /// in the codebase.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation (no code change)
• Refactor (refactoring production code)
• Other

Checklist:

• My code follows the code style of this project.
• I have updated the documentation and changelog accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.
• Rustfmt and Rust-clippy passed.

[orhun]

Thanks for the PR!

[orhun]

Can you also remove these extra newlines?

[orhun]

Unnecessary newlines

[Muhammad-Owais-Warsi]

Just pushed , please check , hope I have not missed anything now 😅

[orhun]

CI is failing due to invalid doc comments: https://github.com/orhun/kmon/actions/runs/11220108587/job/31215613896?pr=174

See https://doc.rust-lang.org/reference/comments.html

I guess we are still not ready :)

[Muhammad-Owais-Warsi]

CI is failing due to invalid doc comments: https://github.com/orhun/kmon/actions/runs/11220108587/job/31215613896?pr=174

See https://doc.rust-lang.org/reference/comments.html

I guess we are still not ready :)

So sorry, actually it is my first time trying rust. I think I have used /// inside the functions , but I think it's not the right way. I'll look into that. Thanks :)

[orhun]

No worries :)

[Muhammad-Owais-Warsi]

CI is failing due to invalid doc comments: https://github.com/orhun/kmon/actions/runs/11220108587/job/31215613896?pr=174
See https://doc.rust-lang.org/reference/comments.html
I guess we are still not ready :)

So sorry, actually it is my first time trying rust. I think I have used /// inside the functions , but I think it's not the right way. I'll look into that. Thanks :)

As per the docs, we have to use // for the comments inside the functions.

[Muhammad-Owais-Warsi]

1. On cargo build i get this

cargo build Compiling kmon v1.6.5 (/home/owais/Documents/kmon) Finished dev profile [unoptimized + debuginfo] target(s) in 4.33s

2. On cargo test

[Muhammad-Owais-Warsi]

1. On cargo build i get this

cargo build Compiling kmon v1.6.5 (/home/owais/Documents/kmon) Finished dev profile [unoptimized + debuginfo] target(s) in 4.33s

2. On cargo test

So should I push these changes.

[orhun]

Yup, please. Those look good

[Muhammad-Owais-Warsi]

Yup, please. Those look good

Done 👍

[orhun]

Can you run cargo fmt and push the changes?

[Muhammad-Owais-Warsi]

Can you run cargo fmt and push the changes?

Can you run cargo fmt and push the changes?

Yeah, sure.

[orhun]

Thanks for your contribution (and bearing with me :D)

[Muhammad-Owais-Warsi]

Thanks for your contribution (and bearing with me :D)
Thank you so much , it was great to contribute first time on rust project. You helped me lot. Thanks again