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
+11 -1
View File
@@ -1,7 +1,17 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Executes different functions based on the command line content
# SYNOPSIS
# _smart_execute
#
# DESCRIPTION
# Bound to Enter, dispatches based on the current commandline buffer.
# Buffers ending in = are evaluated as qalc expressions via _qalc_eval.
# Empty buffers and all other input fall through to normal execution.
# Intended to be bound to a key in key_bindings.fish.
#
# EXAMPLE
# bind \r _smart_execute
function _smart_execute --description 'Execute different functions based on the command line content'
# Get the current command line buffer
set -l cmd (commandline)