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
@@ -1,7 +1,15 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Execute fish_right_prompt
# SYNOPSIS
# fish_right_prompt
#
# DESCRIPTION
# Renders the right-side prompt showing the active Docker context (in blue,
# when non-default) and the current timestamp.
#
# EXAMPLE
# # Rendered automatically by Fish shell; not called directly.
function fish_right_prompt --description 'Execute fish_right_prompt'
# 1. Docker Context in Blue
set -l docker_ctx (docker context show 2>/dev/null)