MooseX:...entation(3)

🌸 NAME 🌸

okay so bestie, this is MooseX::App::Meta::Role::Class::Documentation — a meta class role for command classes 🫶. It's part of the User Contributed Perl Documentation collection, and the header is out here looking like MooseX:...entation(3) (iykyk), but the actual module name is the whole one above 💅.

💜 DESCRIPTION 💜

This meta class role gets automatically applied to all command classes ✨. No extra ceremony, it just shows up like main character energy.

This documentation is only of interest if you intend to write plugins for MooseX::App 🧚. If that's not your vibe, no stress — but if it is, slay, keep reading.

---

🎀 ACCESSORS 🎀

✨ command_short_description ✨

Read/set the short command description. If it's not set, it will be extracted from the Pod NAME or ABSTRACT section. Alternative: it will be taken from the DistZilla ABSTRACT tag.

💖 command_long_description 💖

Read/set the long command description. If it's not set, it will be extracted from the Pod DESCRIPTION or OVERVIEW section.

🦋 command_usage 🦋

Read/set the long command usage. If it's not set, it will be extracted from the Pod SYNOPSIS or USAGE section. If these Pod sections are not defined, the usage will be autogenerated ✨.

✅ command_short_description_predicate ✅

Checks if command_short_description is available.

✅ command_long_description_predicate ✅

Checks if command_long_description is available.

✅ command_usage_predicate ✅

Checks if command_usage is available.

🔥 command_strict 🔥

Read/set the strict command flag. If strict is enabled, the command will terminate with an error message if superfluous/unknown positional parameters are supplied 😭. If disabled, all extra parameters will be copied to the extra_argv attribute.

The app_strict function in the app classes allows one to set this option globally 🌍.

🔥 METHODS 🔥

🔍 _build_command_pod 🔍

Parses the Pod from the command class.

---

that's the whole page, bestie 🎀. this little manual moment is brought to you by perl v5.42.0, dated 2024-08-09 — periodt 💜🦋