lpcdoc

Generate LPCDoc comment blocks for LPC functions, classes, and modules.

8|3|Updated Sep 29, 2021
One-click install
npx skills add https://github.com/gesslar/oxidus-mudlib --skill lpcdoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lpcdoc
Source: https://github.com/gesslar/oxidus-mudlib/tree/main/.claude/skills/lpcdoc
Command: npx skills add https://github.com/gesslar/oxidus-mudlib --skill lpcdoc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

LPCDoc provides a centralized, repeatable standard for documenting LPC functions, classes, and modules, ensuring clear, consistent header comments across a codebase.

Core Features & Use Cases

  • Enforces mandatory descriptions for public LPCDoc blocks and validates essential tags.
  • Guides file-header formatting, typedefs, and property documentation to improve IDE IntelliSense and maintainability.
  • Use Case: when authoring or updating code, consult this guide to generate or validate LPCDoc blocks before commit.

Quick Start

Generate a complete LPCDoc comment block for a given function or object, following the documented structure and tag rules.

Frequently Asked Questions about lpcdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate standardized LPC documentation blocks for my functions?

You generate standardized LPC documentation blocks by creating LPCDoc comment headers that enforce required frontmatter, proper tags, and line-length compliance. This ensures consistent documentation structure across your LPC functions, classes, and modules.

What is the proper format for LPCDoc comment blocks in LPC codebases?

The proper format for LPCDoc comment blocks requires a mandatory frontmatter style, essential validation tags, and readable line-length compliant formatting. This standardizes header comments for public functions, typedefs, and properties.

How do I ensure consistent coding standards for LPC file headers and typedefs?

You ensure consistent coding standards for LPC file headers and typedefs by applying LPCDoc templates during code authoring or updates. This guides formatting and validates documentation to improve IDE IntelliSense and maintainability.

Do I need to add descriptions for every LPCDoc block when documenting LPC modules?

Yes, you need to add descriptions for every public LPCDoc block when documenting LPC modules. The system enforces mandatory descriptions for public blocks and validates essential tags to ensure clear, consistent header comments.

When should I validate LPCDoc blocks during the development workflow?

You should validate LPCDoc blocks during code authoring or updating, before committing changes. Consulting the documentation standard at this stage ensures your LPC functions and objects meet the required frontmatter and tag rules.

What are the limitations of using LPCDoc for LPC documentation?

A key limitation of LPCDoc is its strict enforcement of specific required frontmatter and tag rules, meaning non-compliant or custom comment styles will be rejected to maintain readable, line-length compliant blocks across the project.