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
+19
View File
@@ -1,6 +1,25 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# SYNOPSIS
# pkg [-h] [-i|-u] <package> [package...]
#
# DESCRIPTION
# Installs or removes Arch Linux packages via paru or yay. In auto mode
# (no flag), detects whether each package is installed and toggles it.
#
# ARGUMENTS
# -h, --help Show help message
# -i, --install Force install mode
# -u, --uninstall Force uninstall mode
# package One or more package names to install or remove
#
# RETURNS
# 0 Operation completed
# 1 No AUR helper found, unknown flag, or package operation failed
#
# EXAMPLE
# pkg firefox
function pkg --description 'Install or remove packages via paru or yay'
# ── AUR helper detection ─────────────────────────────────────
set -l aur ""