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
+16 -1
View File
@@ -1,7 +1,22 @@
# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# Run joplin CLI without Node deprecation warnings
# SYNOPSIS
# joplin [args...]
#
# DESCRIPTION
# Runs the Joplin CLI with Node deprecation warnings suppressed via
# NODE_OPTIONS=--no-deprecation.
#
# ARGUMENTS
# args... Arguments forwarded to the joplin command
#
# RETURNS
# 0 Joplin ran successfully
# 1 joplin binary not found in PATH
#
# EXAMPLE
# joplin ls
function joplin --description 'Run Joplin CLI without Node deprecation warnings'
set -l joplin_path (command -v joplin)
if test -n "$joplin_path"