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
+17 -1
View File
@@ -1,7 +1,23 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Pull and restart docker compose containers
# SYNOPSIS
# dockup [-h] [directory]
#
# DESCRIPTION
# Pulls the latest Docker images and restarts all services in a Docker Compose
# project, then prunes dangling images. Accepts an optional target directory.
#
# ARGUMENTS
# -h, --help Show help message
# directory Path to the compose project (defaults to current directory)
#
# RETURNS
# 0 Services updated and running
# 1 Directory not found or no docker-compose.yml present
#
# EXAMPLE
# dockup ~/myapp
function dockup --description 'Pull and restart docker compose containers'
# Define colors
set -l clr_error (set_color red)