Subunits

MlDoC dot commands

Subunits are special paragraphs. They can be used in all structure elements above.

Available subunits (paragraphs)
Name	begin	end	Comment
Named Paragraph	.PA	.AP	Name argument optional
Interface	.IN	.NI	Name argument optional
Example	.EX	.XE	Name argument optional
Preformatted text	.{	.}
Generic Subunit S4	.S4	.4S	Name argument required

Except for a generic subunit, the name argument .NA XXX .AN is optional and can be used for a further description head.
The interface subunit is used to wrap function, value, type or other interfaces. This subunit is used in conjunction with the

• ML-Function
• ML-Value
• ML-Type (abstract types)
• ML-Structure
• ML-Module
• ML-Class
• C-Function/variables

special interfaces. See     Special Interfaces   for more details. The example and the preformatted text subunits are used to display source code or other example lines in a new centered paragraph. The example subunit is put in a box. The preformatted subunit can spawn several pages.

UP MlDoC dot commands