Previous: Version, Up: Documenting Your Code

3.18 Inserting a Short Description

Occasionally, you may need to insert the short description of an element in the current text. To do this, you can copy yourself the short description, or you can insert the element name enclosed in ‘@’, as in the following example1. 

     Example: Inserting a short description  
      1  Summary:
      2
      3  ::``Min``      -- @Min@
      4  ::``Max``      -- @Max@
      5  ::``Multiply`` -- @Multiply@

Footnotes

[1] This example uses a definition list (see Lists).