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:
@@ -1,7 +1,18 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# alias antigravity-ide=antigravity
|
||||
# SYNOPSIS
|
||||
# antigravity-ide [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Wrapper for the antigravity-ide command that filters a known noisy warning
|
||||
# about an unrecognized 'app' option from stderr.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# args... Arguments passed through to the antigravity-ide command
|
||||
#
|
||||
# EXAMPLE
|
||||
# antigravity-ide
|
||||
function antigravity-ide --wraps='antigravity-ide' --description 'alias antigravity-ide=antigravity-ide'
|
||||
# In fish, we pipe stderr using '2>|' to another command
|
||||
command antigravity-ide $argv 2>| grep -v "'app' is not in the list of known options" >&2
|
||||
|
||||
Reference in New Issue
Block a user