documentation/cif_syntax.pod
changeset 78 b3ffff030d5c
parent 7 184a1eb85cf2
equal deleted inserted replaced
77:8df58d8c99e8 78:b3ffff030d5c
   116 Optional. If present, a section titled "See Also" is generated in the resulting documentation. For example:
   116 Optional. If present, a section titled "See Also" is generated in the resulting documentation. For example:
   117 
   117 
   118     ==see-also
   118     ==see-also
   119 
   119 
   120     L<ps|ps>, L<objinfo|objinfo>
   120     L<ps|ps>, L<objinfo|objinfo>
       
   121 
       
   122 =head3 ==smoke-test
       
   123 
       
   124 Commands may optionally specify a snippet of code to test the basic functionality of the command. See the L<ciftest|commands::ciftest> documentation for more details.
   121 
   125 
   122 =head2 The enum type
   126 =head2 The enum type
   123 
   127 
   124 The C<enum> type can be used for an option or argument that takes a limited number of named values, in much the same was as C/C++ enums are used. For an option or argument of type C<enum> you must specify the possible values that the enum can take using the C<==enum-value> keyword. These may optionally have a separate description per value. If any value has an individual description, they all must.
   128 The C<enum> type can be used for an option or argument that takes a limited number of named values, in much the same was as C/C++ enums are used. For an option or argument of type C<enum> you must specify the possible values that the enum can take using the C<==enum-value> keyword. These may optionally have a separate description per value. If any value has an individual description, they all must.
   125 
   129