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
+27 -2
View File
@@ -1,7 +1,22 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Yank to clipboard
# SYNOPSIS
# y [text...]
#
# DESCRIPTION
# Copies text to the system clipboard using wl-copy (Wayland) or xclip (X11).
# Reads from stdin when no arguments are given.
#
# ARGUMENTS
# text Text to copy; reads from stdin if omitted
#
# RETURNS
# 0 Text copied to clipboard
# 1 No clipboard provider found
#
# EXAMPLE
# y "hello world"
function y --description 'Yank to clipboard'
# Check for help flag
if contains -- -h $argv; or contains -- --help $argv
@@ -36,7 +51,17 @@ function y --description 'Yank to clipboard'
end
end
# Alias cb=y
# SYNOPSIS
# cb [text...]
#
# DESCRIPTION
# Alias for y — copies text to the system clipboard.
#
# ARGUMENTS
# text Text to copy; reads from stdin if omitted
#
# EXAMPLE
# ls | cb
function cb --wraps='y' --description 'Alias cb=y'
y $argv
end