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:
+19
-1
@@ -1,7 +1,25 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Execute detach
|
||||
# SYNOPSIS
|
||||
# detach [-h] [--version] <command> [args...]
|
||||
#
|
||||
# DESCRIPTION
|
||||
# Runs a command in the background using nohup, fully detached from the
|
||||
# terminal with all output discarded.
|
||||
#
|
||||
# ARGUMENTS
|
||||
# -h, --help Show help message
|
||||
# --version Show version information
|
||||
# command The command to run detached
|
||||
# args... Additional arguments for the command
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Command launched or help/version shown
|
||||
# 1 No command provided or unknown option
|
||||
#
|
||||
# EXAMPLE
|
||||
# detach rsync -a ./data remote:/backup/
|
||||
function detach --description 'Execute detach'
|
||||
set -l show_help 0
|
||||
set -l args
|
||||
|
||||
Reference in New Issue
Block a user