HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`

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
Webel Mathematica keywords
W`Base`
HelpF`
MOpt
MArg
MFunction
newMethod
helpFunction
MFunction.register
newFunction
$opt$doAutoRegister
Keywords
Click on the image to view it full size

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

Up next
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
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
Snippets (quotes/extracts)
Related slides (includes other tutorials)
HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt
Why the Webel HelpF` & HelpO` registries?
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: helpPackage[$pac$HelpF]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
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)
Related slides (backlinks, includes other tutorials)
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
Basic SysMLv1 example: The HelpM` package MTools classes as Blocks
About «pseudo» blocks (always prefixed with ‘@’)
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions
Visit also
Visit also (backlinks)