WHAT'S NEW?

Mar 01: Michael Sanders demos an X-windows GUI for AWK.

Mar 01: Awk100#24: A. Lahm and E. de Rinaldis' patent search, in AWK

Feb 28: Tim Menzies asks this community to write an AWK cookbook.

Feb 28: Arnold Robbins announces a new debugger for GAWK.

Feb 28: Awk100#23: Premysl Janouch offers a IRC bot, In AWK

Feb 28: Updated: the AWK FAQ

Feb 28: Tim Menzies offers a tiny content management system, in Awk.

Jan 31: Comment system added to awk.info. For example, see discussion bottom of ?keys2awk

Jan 31: Martin Cohen shows that Gawk can handle massively long strings (300 million characters).

Jan 31: The AWK FAQ is being updated. For comments/ corrections/ extensions, please mail tim@menzies.us

Jan 31: Martin Cohen finds Awk on the Android platform.

Jan 31: Aleksey Cheusov released a new version of runawk.

Jan 31: Hirofumi Saito contributes a candidate Awk mascot.

Jan 31: Michael Sanders shows how to quickly build an AWK GUI for windows.

Jan 31: Hyung-Hwan Chung offers QSE, an embeddable Awk Interpreter.

[More ...]

categories: Wp,Dec,2009,PeterI

Convert Comments to Latex

This is adoC, version 1.1. Generates Latex files from source code comments.

Download

Download from LAWKER or http://www.sect.mce.hw.ac.uk

Synopsis

Usage: adoc [options] files_to_parse

Options:

-f

one file per section

-s

sorted per function, variable, etc...

-t title

specify title

--

end of arguments

About

adoC is a source code documenting system written in awk and shell script. It produces documentation in LaTeX format which resembles the Unix man pages. The documentation is generated from comment sections in the source code. The comment sections are marked by two special character sequences and internally divided into sub- parts by keywords. The system can be used with almost any kind of programming language.

The idea is based on ROBODoc http://www.xs4all.nl/~rfsber/Robo/robodoc.html

Requirements

The system requires a working gawk and LaTeX installation. For the LaTeX document the "refart.sty" style should be installed.

Example

adoC is documented by itself .

For the detailed documentation about the system and its implementation execute the following:

	adoc -s -t "adoc" adoc > doc.tex

	$ adoc -s -t "adoc" adoc > doc.tex
	$ latex doc
	$ makeindex doc
	$ latex doc
	$ makeindex doc
	$ latex doc
	$ latex doc
	$ dvips doc

Reporting Bugs

LICENSE

GPL v2.0. Share and enjoy.

Author