HelpO`: addMethod: MTools method registration example for the Webel MAll class and an object

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
Webel Mathematica keywords
W`Base`
HelpO`
addMethod
helpMethod
'rule$arg$'
'$arg$'
Keywords
Click on the image to view it full size
Note that this example is still using "manual" Webel convention 'rule$arg' creation. Once a package is in the MTools space, it can also take advantage of the Webel MArg class, which we already saw briefly earlier:
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
In the next slide we'll examine some methods in the Association-based registry.
Up next
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
Notes
[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: A help Rule 'rule$arg' for an '$arg$' (argument) accepts keys: '$k$help' (required), '$k$def' (required if $k$req = True not given), '$k$req' (True if $k$def not given), '$k$warn', '$k$tip', '$k$lab', '$k$type', '$k$mult' and '$k$pat'
[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?
The Webel HelpO`package class and method registry
HelpO`: addClass: Register an MTools class by fully qualified package name
Webel ‘$arg$’, ‘def$arg$’, and ‘rule$arg$’ convention
Easier ‘$arg$’ and ‘$opt$’ help Rules using the Webel MArg and MOpt helper classes and MTools for OO
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
Related slides (backlinks, includes other tutorials)
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
The Webel W`MOO` packages: MOO = MTools OO support utilities
MAll: methodHelp and methodFind: Short aliases mH and mF
The Webel MAll universal class for MTools integrates with the HelpO` method registry
HelpO`: Options management for MTools methods (lookup replaces OptionValue[])