HelpF`: UsageF ::usage generation: Example helpClass::usage

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
SysML keywords
Block
Mathematica keywords
Association
Rule
List
::usage
Webel Mathematica keywords
W`Base`
HelpF`
usageF
docF
AOR<||>
addFunction
aorMap
'$opt$aor'
'$opt$opts'
'$opt$args'
'$info$f$'
'aor$f$'
'$warn$f$'
'$tip$f$'
Keywords
Click on the image to view it full size

DRY: All arguments and options help information is shared!

Note how the AOR Map is used for the '$opt$aor' option in both the the usageF (for structured ::usage String and signature(s) generation) and in the addFunction (for registration with the HelpF` registry).
Up next
The HelpF` & TestF` packages: General query based help
Notes
[CONVENTION, POLICY, TIP]{STRONG} Webel: Mathematica: Packages that import the Webel HelpF` package (but not MTools and the Webel HelpM` package) should use the 'usageF' function for ::usage String generation (rather than the 'docF' and 'docV' functions) and an AOR Map.
Snippets (quotes/extracts)
Visit also
Visit also (backlinks)
Related slides (includes other tutorials)
DRY not WET! "Don't Repeat Yourself!"
HelpF`: usageF for ::usage generation example
HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
Why the Webel HelpF` & HelpO` registries?
Related slides (backlinks, includes other tutorials)
The AOR Map (Attributes, Options, Rules) Association: Example: aor$f$helpClass