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
+17
View File
@@ -1,6 +1,23 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# SYNOPSIS
# logs [-h] [-c <category>]
#
# DESCRIPTION
# Interactively browses terminal log files (scrollback, paru, yay) sorted
# newest-first using fzf. Supports viewing in $PAGER, editing, and deletion.
#
# ARGUMENTS
# -h, --help Show help message
# -c, --category cat Filter to one category: scrollback, paru, or yay
#
# RETURNS
# 0 File viewed or no file selected
# 1 No log files found
#
# EXAMPLE
# logs -c paru
function logs --description 'Browse terminal log files interactively with fzf'
set -l options h/help c/category=
argparse $options -- $argv