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:
+12
-1
@@ -1,7 +1,18 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# alias ffetch=fastfetch
|
||||
# SYNOPSIS
|
||||
# ffetch [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Alias for fastfetch that loads a custom config from ~/.fastfetch.jsonc when
|
||||
# present. Falls back to neofetch if fastfetch is not installed.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# args... Arguments forwarded to fastfetch or neofetch
|
||||
#
|
||||
# EXAMPLE
|
||||
# ffetch
|
||||
function ffetch --wraps='fastfetch' --description 'alias ffetch=fastfetch'
|
||||
if which fastfetch >/dev/null 2>&1
|
||||
if ls ~/.fastfetch.jsonc >/dev/null 2>&1
|
||||
|
||||
Reference in New Issue
Block a user