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
+9 -1
View File
@@ -23,7 +23,15 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Placeholder for a future implementation of a "fast" function
# SYNOPSIS
# fast
#
# DESCRIPTION
# Displays a styled message indicating that the fast command is unavailable
# and suggests using fast-cli instead.
#
# EXAMPLE
# fast
function fast --description 'Placeholder for future fast utility'
# ANSI Escape Codes (Standard 16-color palette)
set -l bold "\e[1m"