Changeset 2356 for trunk/doc/misc/perlCodeConventions.tex

Timestamp:

Nov 12, 2004, 12:31:58 PM (22 years ago)

Author:

jhoblitt

Message:

update Perl Documentation

File:

• trunk/doc/misc/perlCodeConventions.tex (modified) (5 diffs)

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.9 2004-11-12 22:06:19 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.10 2004-11-12 22:31:58 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -165 +165 @@
 # Copyright (C) 2004  Joshua Hoblitt
 #
-# $Id: perlCodeConventions.tex,v 1.9 2004-11-12 22:06:19 jhoblitt Exp $
+# $Id: perlCodeConventions.tex,v 1.10 2004-11-12 22:31:58 jhoblitt Exp $
 
 use 5.008005;   # optional
@@ -222 +222 @@
 # Copyright (C) 2004  Joshua Hoblitt
 #
-# $Id: perlCodeConventions.tex,v 1.9 2004-11-12 22:06:19 jhoblitt Exp $
+# $Id: perlCodeConventions.tex,v 1.10 2004-11-12 22:31:58 jhoblitt Exp $
 
 package Foo;
@@ -247 +247 @@
 \subsubsection{Perl Documentation}
 
-In most cases documentation should be included as in line Pod within a
-\code{.pl} file.  If a piece of stand alone documentation is required this is
-the general format that it should follow:
+In most cases documentation should be included as ether in-line Pod or after
+the \code{__END__} token in a \code{.pl} file.  The format for documentation
+embedded in a \code{.pl} file after the \code{__END__} token or as a stand
+alone file is as follows:
 
 \begin{verbatim}
@@ -1197 +1198 @@
 %------------------------------------------------------------------------------
 
-\section{How to Achieve This Style with Astyle}
-\label{astyle}
+\section{How to Achieve This Style with Perltidy}
+\label{perltidy}
 
 The purpose of a coding standard is to improve coding efficiency, not