Skip to content
Rip documentation from the comments in the beginning of file
Perl
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
AUTHORS
COPYING
ChangeLog
INSTALL
Makefile
README
README.history
pod2man.mk

README

README: ripdoc.el
-----------------

Description

	Extract documentation from comments at the beginning of file.

	Extract documentation which follows Technical Text Format[1]
	guidelines from the beginning of file; inside comments. Useful
	for languages that do not have built-in doc-format comment
	like Java, Python, Perl, C/C++ doxygen.

Important files

    	COPYING		GPL-2+ Licence
    	INSTALL         Install instructions
    	ChangeLog	Project change records

Project details

	Homepage	http://freecode.com/projects/perl-ripdoc
	Bugs		Contact maintainer (see file AUTHORS)
	Source code	Contact maintainer (see file AUTHORS)

	Depends
	- Standard perl, any modern version.

Refences

	[1] Technical Text Format. A white-paper style rules, where
	Heading 1 is at colun 1, heading 2 is half-tab (column 4) and
	standard text is at tab position (column 8). See comments in
	http://git.savannah.gnu.org/cgit/emacs-tiny-tools.git/tree/lisp/tiny/tinytf.el

	Program to convert TF into HTML is at
	<http://freecode.com/projects/perl-text2html>. A showcase at
	<http://pm-doc.sourceforge.net/doc>.

License

	This program is free software; you can redistribute and/or modify
	program under the terms of GNU General Public license either version 2
	of the License, or (at your option) any later version.

End of file
Something went wrong with that request. Please try again.