[lazarus] Document formatting

Michael A. Hess mhess at miraclec.com
Wed Apr 5 14:28:35 EDT 2000


We have another release of Pasdoc available and it almost takes care of
all of the LCL coding tricks. It just has one or two more things that
need tweeking. In any event I will be generating a new set of docs
shortly. Probably tomorrow. One little item. I notice that people are
starting to put comments in for Pasdoc, GREAT! If you place your name
and email address in a comments block be sure to place it in an
@author() tag. Ex:

@abstract(Simple explaination)
@author(Created by Super Great Coder - sgc at myhome.com)
Further details about the class or unit.

If you do not place it in the @author() tag, pasdoc thinks that the '@'
in the address is a link and tried to interpret it. This places a
WARNING: flag in the documentation that looks very out of place.

As soon as we have all of the kinks worked out of Pasdoc I will then
take one unit and completely comment it as an example.

==== Programming my first best destiny! ====

Michael A. Hess      Miracle Concepts, Inc.
mhess at miraclec.com   http://www.miraclec.com

More information about the Lazarus mailing list