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
+18 -1
View File
@@ -1,7 +1,24 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Run Bash commands replaying changes in Fish
# SYNOPSIS
# replay <commands>
#
# DESCRIPTION
# Runs the given commands in Bash and replays any resulting environment
# variable, alias, and directory changes back into the current Fish
# session. Useful for sourcing Bash-only scripts.
#
# ARGUMENTS
# commands Bash command string to execute and replay
#
# RETURNS
# 0 Commands ran successfully and changes were replayed
# 1 Bash command exited with a non-zero status
#
# EXAMPLE
# replay "source ~/.bashrc"
# replay "export FOO=bar"
function replay --description 'Run Bash commands replaying changes in Fish'
switch "$argv"
case -v --version