Documentation for programmers

From Palp
Revision as of 16:31, 15 May 2012 by Abraun (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Currently the only reasonably well documented file in the package is the global header file Global.h which lists global type definitions and routines, including all the routines called by the original version of poly.x. The ideal of documenting everything (including the code) seems utterly unattainable and even the more modest goal of supplying good descriptions of all the structures and routines occurring in all header files is probably beyond what can be achieved. Perhaps it will be possible to provide clear documentation at least for the routines called by the new ('-x') options of poly.x and for the essential routines of the 'nef'-part of the package as listed in Nef.h. As the most important header files correspond to applications (Subpoly.h to class.x, Nef.h to nef.x and Global.h to poly.x) we will include their discussion in the respective documentation pages. Two minor files LG.h and Rat.h are described briefly at the end of the last section of the paper.

Personal tools
Namespaces

Variants
Actions
Navigation
Tools