HelpM`: Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help 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`
HelpO`
MOpt
MArg
MMethod
MClass
Package
MPackage
MFunction
MPackage.help
MPackage.tree
HelpF`
Keywords
Click on the image to view it full size

With additional metadata fields the MPackage and supporting MFunction, MArg, and MOpt classes could in principle by used to completely generate Documentation Center compliant documentation, although that capability is currently a low priority for the Webel projects.

Up next
Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`
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]{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.
[CAPABILITY]{SUBJECT-TO-CHANGE} Mathematica: Webel ADT pseudo classes: There does not seem to be a way to register ::usage specific to a Webel ADT-Method (TagSetDelayed UpValue). The Webel libraries offer method documentation support 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 MFunction and MMethod helper classes with MArg & MOpt
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
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
The Webel HelpO`package class and method registry
HelpO`: addClass: Register an MTools class by fully qualified package name
HelpO`: addClass: Register an MTools class by fully qualified package name
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
Webel ‘$opt$’ help is much easier with the MOpt class using MTools!
Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt!
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: helpPackage[$pac$HelpF]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset
HelpF`: Pull Mathematica Options[] for a function registered with addFunction
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)
Basic SysMLv1 example: The HelpM` package MTools classes as Blocks
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