nästa upp förra
Nästa: Datatypskommentar Upp: Modulkommentar Förra: Form

Innehåll

Modulkommentar för en list-ADT

/* NAME
 *   list_new, list_new_n, list_size, list_capacity, list_empty,
 *   list_before, list_after, list_first, list_last, list_next, list_prev, 
 *   list_pos, list_nth, list_elem, list_insert, list_remove, list_replace,
 *   list_flush, list_delete 
 *   -- routines for managing a list 
 *
 * SYNOPSIS
 *   cc [flags] files List.o [libraries]
 *
 *   #include "List.h"
 *
 *   List *list_new (void)
 *   List *list_new_n (int capacity)
 *
 *   int list_size (List *list)
 *   int list_capacity (List *list)
 *   bool list_empty (List *list)
 *   Pos list_before (List *list)
 *   Pos list_after (List *list)
 *   Pos list_first (List *list)
 *   Pos list_last (List *list)
 *   Pos list_next (List *list, Pos pos)
 *   Pos list_prev (List *list, Pos pos)
 *   Pos list_pos (List *list, int n)
 *   Element list_nth (List *list, int n)
 *   Element list_elem (List *list, Pos pos)
 *
 *   void list_insert (List *list, Pos *pos, Element elem)
 *   void list_remove (List *list, Pos *pos)
 *   void list_replace (List *list, Pos pos, Element elem)
 *   void list_flush (List *list)
 *
 *   void list_delete (List *list)
 *
 * DESCRIPTION
 *   All list and position arguments must be valid.
 * 
 * SEE ALSO
 *   List
 *
 * VERSION
 *   2.0
 *
 * AUTHOR
 *   Jonas Mölsä       <jbm@nada.kth.se> (interface and documentation)
 *   Richard Spångberg <rsp@nada.kth.se> (interface and documentation)
 *
 */

Under DESCRIPTION så anger man bara generella saker som gäller alla rutiner, eller grupper av rutiner. Funktions- och procedurkommentarerna finns ju redan ihop med respektive funktion och procedur. Kommandot genman i PREF-systemet extraherar funktions- och procedurkommentarerna (ihop med själva rutinhuvudet) och lägger dessa sist i descriptiondelen, när det tillverkar manbladet.



Jonas Mölsä
Sat Sep 13 13:46:34 MET DST 1997