- Home
- About
- SysML/MBSE Training
- SysML Parsing Analysis
- Services
- Model-Based Systems Engineering
- SysML/MBSE Training
- Educational Consultancy
- Model-Driven Software Engineering
- UML Analysis and Design
- Mathematica: Data analysis & visualisation
- Spreadsheet data extraction and migration
- Drupal CMS web sites
- Technical Media: Video, Audio, Graphics
- Synthesis, simulation, animation
- Photography
- R & D
- Keywords
- Contact
docF
Webel Wolfram Language libraries: A function from the Doc` package for generating 
::usage documentation Strings from a List of Strings. Offers lower-level packages at least some degree of structured documentation generation. Typically used in combination with the docV argument and/or option help String snippet generator.
For full help integration using MTools and the Webel HelpM` classes visit MArg, MOpt, MFunction, MClass, and MMethod.
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 lower-level docF and docV functions (with direct '$doc$' Strings). For functions of any complexity and/or where argument and options sequences are shared between functions, use of an AOR Map (Arguments, Options, Rules) Association via the '$opt$aor' option for the usageF function is recommended (rather than "manually" creating help Rule Associations from 'rule$arg$' or 'rule$opt$' help Rules).[Only the HelpF` package itself should usually need to use an ODR Map Options, Docs, Rules Association.]
