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
+10 -1
View File
@@ -1,7 +1,16 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Update README.md with recent changes using Claude-code
# SYNOPSIS
# claude-docs
#
# DESCRIPTION
# Invokes Claude Code to analyze recent repository changes and update
# README.md, ensuring all features and examples are accurate and pruning
# obsolete content.
#
# EXAMPLE
# claude-docs
function claude-docs --description 'Claude-code: Sync README with recent changes'
claude "Analyze the recent changes and update the README.md to ensure all features, setup instructions, and examples are 100% accurate. Prune any obsolete information."
end