We suggest the following sketchy HTML for the class descriptions files.
An example of class description file
may be found at
http://tarzan.aoc.nrao.edu/~wyoung/protopages/split1.html.
<!doctype html public "-//IETF//DTD HTML 3.0//EN"> <html> <head> ! ! style will hopefully allow us to get rid of the netscape table extensions ! <style notation=css> H1: text-color = red TABLE {border-style: none;} TABLE {padding: 0px;} TABLE {border-width: 0px;} </style> </head> <body> ! !At the top ! anchor to Programmer Reference Manual ! anchor to Package document, anchor to Module ! include path for .h file ! <a href="../../RefManual.html#Tables">AIPS++ Programmer Reference Manual</a> <h1>Package <a href="../../Aips.html#aips"> aips </a> - Module <a href="../Tables.html#TableVector">Tables</a></h1> <h1> include file with anchor back to summary file <hr> <h1> Class name with anchor to source file or html file <hr> <h1> Description Pretty much as is now ! ! For the member descriptions ! <hr><hr> <h1> Member Descriptions </h1> <hr> <h2> Public Functions <h2> <dl compact> ! ! For functions with zero or one argument ! <dt><a name="...">Function() <p><dd> Description of function <p> <hr> ! ! For function with more than one argument we want them to ! line up one under the other so we use a table <dt> <table border=0 cellsizing=0 cellpadding=0> <tr><td align=right valign=top><a name="..."Return type function( <td align=left> type arg1, <tr><td><td align=left>type arg2, <tr><td><td align=left>type last_arg) </table> <p><dd> Description of function <p> <hr> ! ! Grouped functions ! <dt> <h3><a name="group_name">Group</a></h3> Description of group <hr> <dl> ! ! Do function as above, Groups maybe nested similarly ! !End of dl for group functions </dl> ! Last function put <hr> after </dl> <hr> !End of dl for all functions </dl> ! ! Last one in definition list put <hr> after </dl> <h2> Protected Functions</h> <dl> ! ! Protected function definitions here </dl> <hr> <a href="http://tarzan.aoc.nrao.edu/cgi-bin/wwwgnats.pl"> Comments, suggestions, and bug reports</a> <p>Generated on yyyy mmm dd by cxx2html version x.x <P>Copyright © 1995 Associated Universities Inc., Washington, D.C.</P> </body> </html>