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:
+18
-1
@@ -1,7 +1,24 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Put from clipboard
|
||||
# SYNOPSIS
|
||||
# p [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Outputs clipboard contents to stdout. Uses wl-paste on Wayland,
|
||||
# falls back to xclip on X11. Supports -h/--help for usage info.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# -h, --help Show usage help
|
||||
# args... Arguments forwarded to the clipboard tool
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Clipboard contents printed successfully
|
||||
# 1 No supported clipboard tool found
|
||||
#
|
||||
# EXAMPLE
|
||||
# p | grep foo
|
||||
# p > file.txt
|
||||
function p --description 'Put from clipboard'
|
||||
# Check for help flag
|
||||
if contains -- -h $argv; or contains -- --help $argv
|
||||
|
||||
Reference in New Issue
Block a user