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
+17 -1
View File
@@ -1,7 +1,23 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Run a command while inhibiting system sleep
# SYNOPSIS
# wake-lock <command> [args...]
#
# DESCRIPTION
# Runs a command under systemd-inhibit to prevent the system from idling
# or sleeping for the duration of the command.
#
# ARGUMENTS
# command Command to run with sleep inhibition active
# args... Arguments forwarded to the command
#
# RETURNS
# 0 Command ran and completed
# 1 No command provided
#
# EXAMPLE
# wake-lock rsync -avz src/ dest/
function wake-lock --description 'Run a command while inhibiting system sleep'
if test (count $argv) -eq 0
echo "Usage: wake-lock [command] [args...]"