The program bfort searches for C comments of the form /* c
...
c*/, where c is a single character indicating the type of
documentation. The available types include @ for
routines and M for C macros.
These structured comments can be used by doctext [(ref doctext)] to
automatically generate manual pages and may containing additional information.
In all cases, the structured comment has the form
/*@ name - short descriptionThe structured comment for a routine must immediately precede the declaration of the routine (currently only K&R-style declarations; ANSI-style prototypes will be supported in a later release). Figure 1 shows the structured comment and the routine being documented.heading 1:
heading 2:
... @*/