HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help

Gallery
Tutorial
[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.
Section
SECTION: The Webel '$opt$' and '$arg$' help holder conventions for options and arguments in the Wolfram Language
Mathematica keywords
MTools
MTools::Class
::usage
Webel Mathematica keywords
help holder
MArg
'$opt$'
'$arg$'
'$doc$'
'$doc$arg$'
'$doc$opt$'
MOpt
MOpt.$doc
MArg.$doc
HelpM`
Keywords
Click on the image to view it full size

Once you have MArg and MOpt objects you can use them in many different ways. They can be combined also with the MFunction and MMethod classes from the HelpM` package, which we'll look at later once we've looked more into the HelpF` and HelpO` packages and their function and method help registries.

If you wish to jump ahead a bit, open these slide pages in a separate tab:

HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt
HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
HelpM`: Using the Webel MClass helper with the MMethod helper and the HelpO` help registry
Up next
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions
Notes
[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: Argument help holders use a String variable with the prefix '$arg$', a related '$info$arg$' String, a 'def$arg$' default value expression and/or 'req$arg$', and optional '$warn$arg$', '$tip$arg$, '$lab$arg$', 'type$arg$'..
[PATTERN, TIP, TOOL]{INFORMATIVE} Webel + Mathematica + MTools + SysML
[TIP]{INFORMATIVE} Mathematica: TIPS for living with the user-contributed MTools for Object-Orientation (until a vendor-supported OO solution is eventually provided)
[CONVENTION, NAMING, POLICY]{SUGGESTED} Webel: Mathematica: CONVENTION: A '$doc$' prefix indicates a formatted documentation String helper. A '$doc$arg$' is for an argument, a '$doc$opt$' is for an option. A '$doc$ String may be used to create ::usage documentation via docF.
[CONVENTION, NAMING, POLICY]{SUGGESTED} Webel: Mathematica: CONVENTION: A '$doc$' prefix indicates a formatted documentation String helper. A '$doc$arg$' is for an argument, a '$doc$opt$' is for an option. A '$doc$ String may be used to create ::usage documentation via docF.
Snippets (quotes/extracts)
Visit also
The Webel SysML4Mathematica recipe for modelling Wolfram Language code in Systems Modeling Language (SysML) for Model-Based Systems Engineering
Visit also (backlinks)
Webel: Mathematica: CONVENTION: A prefix '$doc' indicates a documentation String for each primary variable/quantity (argument or output)
Related slides (includes other tutorials)
The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"
The Webel '$opt$' option "help holder" convention
Make a Webel option help Rule relying on ‘$opt$’ naming conventions
Easier ‘$arg$’ and ‘$opt$’ help Rules using the Webel MArg and MOpt helper classes and MTools for OO
Webel ‘$opt$’ help is much easier with the MOpt class using MTools!
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt!
Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage
Related slides (backlinks, includes other tutorials)
The Webel W`Moo` package group: Additional utilities for the user-contributed MTools paclet for classes & object orientation
Deployment folders for projects that depend on W`Base` and MTools OO (as SysML)
Doc` package ::usage help generation using the docV and docF functions (2)
HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt
HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`
HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
HelpM`: Using the Webel MClass helper with the MMethod helper and the HelpO` help registry
Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`
HelpM`: Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help registries
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions
The AOR Map (Arguments, Options, Rules): Integrated ::usage, HelpF`/HelpO` registration, and Options[] (without MTools)
The AOR Map (Attributes, Options, Rules) Association: Example: aor$f$helpClass
The AOR Map as SysML Blocks with Rules
HelpF`: usageF for ::usage generation example
HelpF`: UsageF ::usage generation: Example helpClass::usage