HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)

Gallery
Tutorial
[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.
Section
SECTION: The Webel Doc` package and the HelpF, HelpO`& HelpM` help registry packages
Mathematica keywords
MTools
MTools::Class
MTools::method
Association
::usage
Webel Mathematica keywords
W`Base`
HelpF`
HelpO`
MOpt
MArg
MFunction
MFunction.$doc
MMethod
MMethod.$doc
MMethod.tree
MFunction.tree
Keywords
Click on the image to view it full size

An MFunction object can generate a highly structured ::usage documentation String. Note that the generated help contains the same information as that registered with the HelpF` registry.

An MMethod object can similarly generate a highly structured ::usage-similar documentation String, which help contains the same information as that registered with the HelpO` class & methods registry. However, it's not clear how to actually use it with ::usage:

Webel: Mathematica: The Method syntax for the user contributed MTools does not seem to support Method-specific ::usage. The Webel libraries offer method documentation support (including arguments and options) via the HelpO` class/method registry.

In any case, the help as stored in the HelpF` and HelpO` registries is far richer, is supported by many useful views and queries, and serves as the primary package function and class method documentation for Webel projects.

Overview of the Webel HelpM` package with MTools-based help helper classes

Up next
HelpM`: Using the Webel MClass helper with the MMethod helper and the HelpO` help registry
Notes
[TIP]{INFORMATIVE} Mathematica: TIPS for living with the user-contributed MTools for Object-Orientation (until a vendor-supported OO solution is eventually provided)
[PATTERN, TIP, TOOL]{INFORMATIVE} Webel + Mathematica + MTools + SysML
[POLICY]{STRONG} About the Single Source of Truth (SSOT) and Don't Repeat Yourself (DRY) principles
[POLICY]{SUBJECT-TO-CHANGE} Webel: Mathematica: The Method syntax for the user contributed MTools does not seem to support Method-specific ::usage. The Webel libraries offer method documentation support (including arguments and options) via the HelpO` class/method registry.
Snippets (quotes/extracts)
Visit also
Visit also (backlinks)
Related slides (includes other tutorials)
Why the Webel HelpF` & HelpO` registries?
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`
HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: helpPackage[$pac$HelpF]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
Webel ‘$opt$’ help is much easier with the MOpt class using MTools!
Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt!
HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset
HelpF`: Pull Mathematica Options[] for a function registered with addFunction
The HelpF` & TestF` packages: General query based help
HelpF`: packageFunctionTree[$pac]: Function ::usage help and signatures within a package
TestF`: Function search by argument number/kind to aid testing automation (1)
The Webel HelpO`package class and method registry
HelpO`: addMethod: MTools method registration example for the Webel MAll class and an object
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
HelpO`: Find help on a method of a Webel MAll universal class object
DRY not WET! "Don't Repeat Yourself!"
Related slides (backlinks, includes other tutorials)
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
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
Basic SysMLv1 example: The HelpM` package MTools classes as Blocks
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions
Generate shared option groups using ‘$opt$’ helpers: wl$optsFromOpts, docsFromOpts, rulesFromOpts, and odrMap triplet
HelpF`: OptionsPattern groups as SysML shared between functions
Webel ODR (Options, Docs, Rules) as SysML
HelpF`: usageF for ::usage generation example
HelpF`: UsageF ::usage generation: Example helpClass::usage