Return to Example CVS log

Up to [MW Coherent from dump] / coherent / a / usr / man / ALL

coherent

example                      Example                      example




Give an example of Mark Williams Lexicon format

#include <example.h>
cchhaarr *eexxaammppllee(_f_o_o, _b_a_r) iinntt _f_o_o; lloonngg _b_a_r;

This  is  an  example of  the  Mark  Williams  Lexicon format  of
software documentation.   At this point,  each entry has  a brief
narration that discusses the topic in detail.

The  lines in  bboollddffaaccee describe  how to  use the  function being
described.  The first  line, #iinncclluuddee <eexxaammppllee.hh>, indicates that
this function requires  the imaginary header file eexxaammppllee.hh.  The
second  line gives  the syntax  of  the function.   char *example
means that the imaginary  function eexxaammppllee returns a pointer to a
cchhaarr.  foo and bar  are example's arguments: foo must be declared
to be an int, and bar must be declared to be a long.

***** Example *****

The following program gives an example of an example.


main()
{
        printf("Many entries include examples\n");
}


***** See Also *****

Lexicon, all other related topics and functions

***** Notes *****

If a Lexicon  entry uses a technical term that  you do not under-
stand, look it  up in the Lexicon.  In this  way, you will gain a
secure understanding of how to use COHERENT.



















COHERENT Lexicon                                           Page 1

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.