|
|
1.1 ! root 1: ! 2: ! 3: example Example example ! 4: ! 5: ! 6: ! 7: ! 8: Give an example of Mark Williams Lexicon format ! 9: ! 10: #include <example.h> ! 11: cchhaarr *eexxaammppllee(_f_o_o, _b_a_r) iinntt _f_o_o; lloonngg _b_a_r; ! 12: ! 13: This is an example of the Mark Williams Lexicon format of ! 14: software documentation. At this point, each entry has a brief ! 15: narration that discusses the topic in detail. ! 16: ! 17: The lines in bboollddffaaccee describe how to use the function being ! 18: described. The first line, #iinncclluuddee <eexxaammppllee.hh>, indicates that ! 19: this function requires the imaginary header file eexxaammppllee.hh. The ! 20: second line gives the syntax of the function. char *example ! 21: means that the imaginary function eexxaammppllee returns a pointer to a ! 22: cchhaarr. foo and bar are example's arguments: foo must be declared ! 23: to be an int, and bar must be declared to be a long. ! 24: ! 25: ***** Example ***** ! 26: ! 27: The following program gives an example of an example. ! 28: ! 29: ! 30: main() ! 31: { ! 32: printf("Many entries include examples\n"); ! 33: } ! 34: ! 35: ! 36: ***** See Also ***** ! 37: ! 38: Lexicon, all other related topics and functions ! 39: ! 40: ***** Notes ***** ! 41: ! 42: If a Lexicon entry uses a technical term that you do not under- ! 43: stand, look it up in the Lexicon. In this way, you will gain a ! 44: secure understanding of how to use COHERENT. ! 45: ! 46: ! 47: ! 48: ! 49: ! 50: ! 51: ! 52: ! 53: ! 54: ! 55: ! 56: ! 57: ! 58: ! 59: ! 60: ! 61: ! 62: ! 63: ! 64: COHERENT Lexicon Page 1 ! 65: ! 66:
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.