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
+12 -1
View File
@@ -1,7 +1,18 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# alias view=nvim -R
# SYNOPSIS
# view [args...]
#
# DESCRIPTION
# Opens files in nvim read-only mode (-R). Falls back to less if nvim
# is not installed.
#
# ARGUMENTS
# args... Files or options forwarded to nvim -R or less
#
# EXAMPLE
# view /etc/fstab
function view --wraps='nvim -R' --description 'alias view=nvim -R'
if type -q nvim
nvim -R $argv