tools/cxref/ANNOUNCE

   1     C Cross Referencing & Documenting tool. Version 1.5g - cxref
   2     ============================================================
   3
   4 Cxref is a program that will produce documentation (in LaTeX, HTML, RTF or SGML)
   5 including cross-references from C program source code.
   6
   7 Works for ANSI C, including most gcc extensions.
   8
   9 The documentation for the program is produced from comments in the code that
  10 are appropriately formatted. The cross referencing comes from the code itself
  11 and requires no extra work.
  12
  13 The documentation is produced for each of the following:
  14
  15 Files            - A comment that applies to the whole file.
  16 Functions        - A comment for the function, including a description of
  17                    each of the arguments and the return value.
  18 Variables        - A comment for each of a group of variables and/or
  19                    individual variables.
  20 #include         - A comment for each included file.
  21 #define          - A comment for each pre-processor symbol definition, and
  22                    for macro arguments.
  23 Type definitions - A comment for each defined type and for each element of a
  24                    structure or union type.
  25
  26 Any or all of these comments can be present in suitable places in the
  27 source code.
  28
  29
  30 The cross referencing is performed for the following items
  31
  32 Files           - The files that the current file is included in
  33                   (even when included via other files).
  34
  35 #includes       - Files included in the current file.
  36                 - Files included by these files etc.
  37
  38 Variables       - The location of the definition of external variables.
  39                 - The files that have visibility of global variables.
  40                 - The files / functions that use the variable.
  41
  42 Functions       - The file that the function is prototyped in.
  43                 - The functions that the function calls.
  44                 - The functions that call the function.
  45                 - The files and functions that reference the function.
  46                 - The variables that are used in the function.
  47
  48 Each of these items is cross referenced in the output.
  49
  50 Includes extensive README and FAQ with details and examples on how to use the
  51 program.
  52
  53
  54 Changes
  55 -------
  56
  57 Since version 1.5f:
  58
  59 Bug fixes
  60   New fix allowing a mix of declarations and statements in compound statements.
  61   Fix handling of -Afoo=bar options again.
  62
  63 Configure/Make changes
  64   Add a --without-cxref-cpp option to force using gcc instead of cxref-cpp.
  65
  66 cxref-cpp changes
  67   cxref-cpp now gets gcc defines and include path at runtime from config file.
  68   There is a script cxref-cpp-configure to create this configuration file.
  69
  70
  71 Availability
  72 ------------
  73
  74 Previous versions of this program have been tested on the following systems:
  75 Linux 1.[123].x, Linux 2.[01234].x, SunOS 4.1.x, Solaris 2.x, HPUX 10.x
  76
  77 FTP  server: ftp://ftp.ibiblio.org/pub/Linux/devel/lang/c/cxref-1.5g.tgz
  78 HTTP server: http://www.gedanken.demon.co.uk/download-cxref/cxref-1.5g.tgz
  79
  80 Web page: http://www.gedanken.demon.co.uk/cxref/
  81
  82
  83 Author & Copyright
  84 ------------------
  85
  86 This program is copyright Andrew M. Bishop 1995,96,97,98,99,2000,01,02,03,04
  87 (amb@gedanken.demon.co.uk) and distributed under GPL.
  88
  89 email: amb@gedanken.demon.co.uk
  90 [Please put cxref in the subject line]