htmlindex

htmlindex, a C++ code which builds a "skeleton" HTML page for a C, C++, FORTRAN77 or FORTRAN90 source code file, documenting every routine in the file...if each routine has been appropriately marked. The information after the marker is usually a one line explanations of what the routine does.

For a C file, the special marker line has the form

        Purpose:

          ROUTINE has this purpose.
      

For a C++ file, the special marker line has the form

      // Purpose:
      //
      //    ROUTINE has this purpose.
      

For a FORTRAN77 file, the special marker line has the form

      cc ROUTINE has this purpose.
      

For a FORTRAN90 file, the special marker line has the form

      !! ROUTINE has this purpose.
      

After a little editing, the page is ready for posting.

Usage:

htmlindex myprog.c > myprog.html

• myprog.c is a C file to be processed.

Licensing:

The computer code and data files described and made available on this web page are distributed under the MIT license

Languages:

htmlindex is available in a C++ version.

Related Data and Programs:

catalog, a C++ code which reads a C, C++, FORTRAN77, FORTRAN90, MATLAB, Python, or R code and prints every line that begins with a special index tag. If the code has been marked up expecting this convention, a handy table of contents will be created.

f77split, a C code which reads a FORTRAN77 file and creates individual files for every blockdata, function, module, program, or subroutine in the file.

f90split, a C code which reads a FORTRAN file and creates individual files for every blockdata, function, module, program, or subroutine in the file.

f90split, a FORTRAN90 code which reads a FORTRAN file and creates individual files for every blockdata, function, module, program, subroutine in the file.

fsplit, reads a FORTRAN file and creates individual files for every function, program, or subroutine in the file, by Van Snyder.

htmlindex_test

include_files, a FORTRAN90 program which reads a FORTRAN program with INCLUDE statements, and makes a copy with the indicated files included.

Source Code:

• htmlindex.cpp, the source code;
• htmlindex.sh, compiles the source code;