# function-documentation

> Document public functions with: a brief description of what the function does, @param for each pa... Use when documenting code and APIs. Documentation category skill.

- Author: OmniaffixDave
- Repository: OmniaffixDave/SessionGuardian
- Version: 20260205125233
- Stars: 0
- Forks: 1
- Last Updated: 2026-02-08
- Source: https://github.com/OmniaffixDave/SessionGuardian
- Web: https://mule.run/skillshub/@@OmniaffixDave/SessionGuardian~function-documentation:20260205125233

---

---
name: function-documentation
description: "Document public functions with: a brief description of what the function does, @param for each pa... Use when documenting code and APIs. Documentation category skill."
metadata:
  category: Documentation
  priority: medium
  is-built-in: true
  session-guardian-id: builtin_function_documentation
---

# Function Documentation

Document public functions with: a brief description of what the function does, @param for each parameter with type and description, @returns for the return value, @throws for exceptions, and @example for non-obvious usage. TypeScript types reduce documentation needs but descriptions of behavior are still valuable. Internal/private functions need less documentation.