docs(functions): standardize all function doc blocks to UNIX man-page style

Replace all ad-hoc inline comments between license headers and function
declarations with consistent SYNOPSIS / DESCRIPTION / ARGUMENTS / RETURNS /
EXAMPLE blocks across all 99 project-owned functions/ files. No executable
logic, variable names, or exit codes were modified.

Completes Task #6 from AGENTS.md (Retroactive Function Documentation
Standardization).
This commit is contained in:
2026-06-05 20:18:49 -04:00
parent 0396d685fd
commit 1341e2559e
108 changed files with 1520 additions and 148 deletions
+16 -1
View File
@@ -1,7 +1,22 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Execute du
# SYNOPSIS
# du [--disk|--dir|--dua] [args...]
#
# DESCRIPTION
# Smart disk-usage wrapper that routes to duf (disk overview), dust (directory
# tree), or dua based on context or explicit flags. Falls back to system du
# when the preferred tool is not installed.
#
# ARGUMENTS
# --disk Force duf for disk-level overview
# --dir Force dust for directory-level breakdown
# --dua Force dua interactive mode
# args... Files/directories or flags forwarded to the selected tool
#
# EXAMPLE
# du ~/Downloads
function du --description 'Execute du'
set cmd ""
set args