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:
+14
-9
@@ -1,18 +1,23 @@
|
||||
# Copyright (C) 2026 Rootiest
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Function to run a command in the background, detached from the terminal.
|
||||
# This prevents the command from being terminated when the terminal is closed.
|
||||
# All output (stdout and stderr) is discarded.
|
||||
# SYNOPSIS
|
||||
# bkg <command> [args...]
|
||||
#
|
||||
# Usage:
|
||||
# bkg <command> [arguments...]
|
||||
# DESCRIPTION
|
||||
# Launches a command in the background, fully detached from the terminal
|
||||
# using nohup. All stdout and stderr output is discarded.
|
||||
#
|
||||
# Example:
|
||||
# ARGUMENTS
|
||||
# command The command to run detached
|
||||
# args... Additional arguments for the command
|
||||
#
|
||||
# RETURNS
|
||||
# 0 Command launched successfully
|
||||
# 1 No command provided
|
||||
#
|
||||
# EXAMPLE
|
||||
# bkg firefox
|
||||
# bkg code .
|
||||
#
|
||||
# Execute bkg
|
||||
function bkg --description 'Execute bkg'
|
||||
# Check if a command was provided as an argument.
|
||||
if test -z "$argv[1]"
|
||||
|
||||
Reference in New Issue
Block a user