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.

Webel IT Australia promotes the amazing Mathematica tool and the powerful Wolfram Language and offers professional Mathematica services for computational computing and data analysis. Our Mathematica tips, issue tracking, and wishlist is offered here most constructively to help improve the tool and language and support the Mathematica user community.
DISCLAIMER: Wolfram Research does not officially endorse analysis by Webel IT Australia.
Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
POLICY
Policy level
SUBJECT-TO-CHANGE
Mathematica keywords
MTools
MTools::method
::usage
Webel Mathematica keywords
HelpO`
Keywords

The syntax for defining a class method for the user-contributed MTools package for classes and OO in Mathematica is:

MClass.method[arg_] := (* Use arg *);

Where Class is a user defined MTools class. At the time of writing, no way is known of registering ::usage specific to an MTools method. Dr Darren invites your help:

If you know how to achieve ::usage with MTools methods by all means do contact me and let me know how.

In any case, this is addressed in the Webel libraries for the Wolfram Language by the HelpO` class/method help registry package, as encapsulated also by the MMethod class.

Visit also:

SECTION: The Webel Doc` package and the HelpF, HelpO`& HelpM` help registry packages
Webel: Mathematica: The Method syntax for the user contributed MTools does not seem to support Wolfram Language Options[]. The Webel MTools extensions offer options support via a Webel Options Association in combination with the HelpO` method registry.
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.
Relates to
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
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
HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
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
The Webel MAll universal (intermediate) base class
Related 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
[LIMITATION, TOOL, WISHLIST] Webel: Mathematica: WISHLIST: Support for EXTRACTABLE structured documentation for individual arguments of functions RIGHT IN/NEAR THE CODE. Yes it is needed, really it is. (And ::usage support for "methods" would be nice too.)
Related notes (backlinks)
Related snippets (extracts)
Visit also
SECTION: The Webel Doc` package and the HelpF, HelpO`& HelpM` help registry packages
Visit also (backlinks)