ZyanArgParseDefinition_(3)

πŸ“¦
version 1.5.2 Β· 2 versions
, in ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

ZyanArgParseDefinition_ β€” bestie, this is the lil struct that tells the arg parser what one single argument actually is. It lives in the Library Functions Manual, and honestly? It's doing the most with the least. Iconic behavior. πŸ‘‘

✨ SYNOPSIS ✨

#include <ArgParse.h>

🌸 Public Attributes 🌸

  • const char * name
  • ZyanBool boolean
  • ZyanBool required

πŸ¦‹ Detailed Description πŸ¦‹

The definition of a single argument. That's the whole vibe β€” one argument, one definition, no cap. It's giving "here's what this flag is, here's whether it takes a value, here's whether you actually have to pass it." πŸ’…

πŸŽ€ Member Data Documentation πŸŽ€

πŸ“ ZyanBool ZyanArgParseDefinition_::boolean

Whether the argument is boolean or expects a value. So like… is it a just-flip-the-switch situation, or does it need you to hand it something? This field knows. ⭐

🧚 const char* ZyanArgParseDefinition_::name

The argument name, e.g. --help.

Okay so there are RULES here and you will respect them, bestie:

  • It must start with either one or two dashes.
  • Single dash arguments must consist of a single character, (e.g. -n).
  • Double-dash arguments can be of arbitrary length.
Lowkey don't try to sneak a multi-character single-dash flag in there. The rules said what they said. πŸ™ˆ

πŸ’œ ZyanBool ZyanArgParseDefinition_::required

Whether this argument is required (error if missing). Basically: skip it and the program comes for you. Not metaphorically. <italic>error if missing.</italic> 😭

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Zycore from the source code. So nobody hand-wrote this, it just materialized. Very main character of Doxygen, honestly. 🫢


Alright bestie, that's the whole page β€” big kisses from Zycore, Version 1.5.2.0 and the ZyanArgParseDefinition_(3) girlies. Go forth and define your arguments correctly, periodt. πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from