[PR #597] [MERGED] docs: add rustdoc comments to all module options #6444

New issue

Closed

opened 2026-05-23 01:56:08 +01:00 by JakeStanger · 0 comments

JakeStanger commented

2026-05-23 01:56:08 +01:00

Owner

📋 Pull Request Information

Original PR: https://github.com/JakeStanger/ironbar/pull/597
Author: @JakeStanger
Created: 5/19/2024
Status: ✅ Merged
Merged: 5/23/2024
Merged by: @JakeStanger

Base: master ← Head: docs/modules

📝 Commits (1)

c7743b2 docs: add rustdoc comments to all module options

📊 Changes

24 files changed (+825 additions, -40 deletions)

View changed files

📝 src/config/common.rs (+131 -4)
📝 src/config/mod.rs (+111 -11)
📝 src/config/truncate.rs (+55 -0)
📝 src/modules/cairo.rs (+17 -0)
📝 src/modules/clipboard.rs (+16 -0)
📝 src/modules/clock.rs (+26 -2)
📝 src/modules/custom/box.rs (+17 -0)
📝 src/modules/custom/button.rs (+31 -1)
📝 src/modules/custom/image.rs (+18 -0)
📝 src/modules/custom/label.rs (+20 -1)
📝 src/modules/custom/mod.rs (+20 -2)
📝 src/modules/custom/progress.rs (+35 -0)
📝 src/modules/custom/slider.rs (+49 -0)
📝 src/modules/focused.rs (+11 -0)
📝 src/modules/label.rs (+5 -0)
📝 src/modules/launcher/mod.rs (+18 -0)
📝 src/modules/music/config.rs (+58 -13)
📝 src/modules/notifications.rs (+32 -0)
📝 src/modules/script.rs (+16 -1)
📝 src/modules/sysinfo.rs (+45 -2)

...and 4 more files

📄 Description

This is part of an upcoming effort to generate documentation from code.

Pushing this out before that stage so that the JSON schema is fully documented.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/JakeStanger/ironbar/pull/597 **Author:** [@JakeStanger](https://github.com/JakeStanger) **Created:** 5/19/2024 **Status:** ✅ Merged **Merged:** 5/23/2024 **Merged by:** [@JakeStanger](https://github.com/JakeStanger) **Base:** `master` ← **Head:** `docs/modules` --- ### 📝 Commits (1) - [`c7743b2`](https://github.com/JakeStanger/ironbar/commit/c7743b28c68919e5bb1d8b9c53d63fb53fd3b081) docs: add rustdoc comments to all module options ### 📊 Changes **24 files changed** (+825 additions, -40 deletions) <details> <summary>View changed files</summary> 📝 `src/config/common.rs` (+131 -4) 📝 `src/config/mod.rs` (+111 -11) 📝 `src/config/truncate.rs` (+55 -0) 📝 `src/modules/cairo.rs` (+17 -0) 📝 `src/modules/clipboard.rs` (+16 -0) 📝 `src/modules/clock.rs` (+26 -2) 📝 `src/modules/custom/box.rs` (+17 -0) 📝 `src/modules/custom/button.rs` (+31 -1) 📝 `src/modules/custom/image.rs` (+18 -0) 📝 `src/modules/custom/label.rs` (+20 -1) 📝 `src/modules/custom/mod.rs` (+20 -2) 📝 `src/modules/custom/progress.rs` (+35 -0) 📝 `src/modules/custom/slider.rs` (+49 -0) 📝 `src/modules/focused.rs` (+11 -0) 📝 `src/modules/label.rs` (+5 -0) 📝 `src/modules/launcher/mod.rs` (+18 -0) 📝 `src/modules/music/config.rs` (+58 -13) 📝 `src/modules/notifications.rs` (+32 -0) 📝 `src/modules/script.rs` (+16 -1) 📝 `src/modules/sysinfo.rs` (+45 -2) _...and 4 more files_ </details> ### 📄 Description This is part of an upcoming effort to generate documentation from code. Pushing this out before that stage so that the JSON schema is fully documented. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

JakeStanger

2026-05-23 01:56:08 +01:00