Menu
CTAN
Comprehensive TeX Archive Network
Cover Upload Browse Search

Direc­tory tex-archive/macros/latex/contrib/codedoc

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

Files

Name Size Date Notes
CodeDoc-manual.pdf 598708 2010-03-30 12:07
CodeDoc-manual.tex 156353 2010-03-30 12:05
README 977 2010-03-30 12:07
codedoc.cls 46009 2010-03-30 12:05

Down­load the con­tents of this pack­age in one zip archive (408.7k).

code­doc – LaTeX code and doc­u­men­ta­tion in LaTeX-for­mat file

The CodeDoc class is an al­ter­na­tive to DocStrip (and oth­ers) to pro­duce LaTeX code along with its doc­u­men­ta­tion with­out de­part­ing from LaTeX's or­di­nary syn­tax.

The doc­u­men­ta­tion is pre­pared like any other LaTeX doc­u­ment and the code to be com­mented ver­ba­tim is sim­ply de­lim­ited by an en­vi­ron­ment. When an op­tion is turned on in the class op­tions, this code is writ­ten to the de­sired file(s).

The class also in­cludes fully cus­tomiz­able ver­ba­tim en­vi­ron­ments which pro­vide the au­thor with sep­a­rate com­mands to type­set the ma­te­rial and/or to ex­e­cute it.

Pack­age De­tailscode­doc
Ver­sion0.3
Li­censeThe LaTeX Project Public Li­cense
Main­tainerPaul Isam­bert
Con­tained inTeXlive as code­doc
MikTeX as code­doc
Topics macros and tools for prepar­ing doc­u­men­ta­tion
See also gmdoc
doc
Guest Book Sitemap Contact