CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/codedoc

README
This is the file README for the CodeDoc class, v.0.3.
You'll find complete documentation in CodeDoc-manual.pdf

This class produces code and documentation in a single file without departing from LaTeX's ordinary
syntax.


TO PRODUCE THE DOCUMENTATION:
Run LaTeX on CodeDoc-manual.tex (better in PDF).
In the document class options of the latter file,
you may uncomment the `obeystop' option and/or
comment out the `index' option to remove the
implementation from the documentation and/or
the index.
Don't forget to run LaTeX and MakeIndex as many
times as necessary.

TO PRODUCE THE CLASS ITSELF (codedoc.cls):
Uncomment the `produce' option among the
class options and run LaTeX on the same file
(CodeDoc-manual.tex).
This serves as an illustration only, since
to do so you already need codedoc.cls, obviously.
This file should thus be included in any distribution.


Licensing of this package is covered by LPPL.

Any reaction is welcome: zappathustra@free.fr

Paul Isambert

Download the contents of this package in one zip archive (408.7k).

codedoc – code and documentation in -format file

The CodeDoc class is an alternative to DocStrip (and others) to produce code along with its documentation without departing from 's ordinary syntax.

The documentation is prepared like any other document and the code to be commented verbatim is simply delimited by an environment. When an option is turned on in the class options, this code is written to the desired file(s).

The class also includes fully customizable verbatim environments which provide the author with separate commands to typeset the material and/or to execute it.

Packagecodedoc
Version0.3
LicensesThe Project Public License
MaintainerYuri Robbers
Paul Isambert (inactive)
Contained inTeX Live as codedoc
MiKTeX as codedoc
TopicsDocumentation support
See alsodoc
gmdoc
...
Guest Book Sitemap Contact Contact Author