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

Timestamp:

Nov 12, 2004, 12:06:19 PM (22 years ago)

Author:

jhoblitt

Message:

fix latex syntax

File:

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

trunk/doc/misc/perlCodeConventions.tex

@@ -1 @@
-%%% $Id: perlCodeConventions.tex,v 1.8 2004-11-12 21:58:22 jhoblitt Exp $
+%%% $Id: perlCodeConventions.tex,v 1.9 2004-11-12 22:06:19 jhoblitt Exp $
 \documentclass[panstarrs]{panstarrs}
 
@@ -165 +165 @@
 # Copyright (C) 2004  Joshua Hoblitt
 #
-# $Id: perlCodeConventions.tex,v 1.8 2004-11-12 21:58:22 jhoblitt Exp $
+# $Id: perlCodeConventions.tex,v 1.9 2004-11-12 22:06:19 jhoblitt Exp $
 
 use 5.008005;   # optional
@@ -222 +222 @@
 # Copyright (C) 2004  Joshua Hoblitt
 #
-# $Id: perlCodeConventions.tex,v 1.8 2004-11-12 21:58:22 jhoblitt Exp $
+# $Id: perlCodeConventions.tex,v 1.9 2004-11-12 22:06:19 jhoblitt Exp $
 
 package Foo;
@@ -842 +842 @@
 \begin{verbatim}
 my @things = qw( foo bar baz );
+\end{verbatim}
 \end{itemize}
 
@@ -1076 +1077 @@
 \label{SourceExample} 
 
-\tbd{Need to include more of the rules, and shorten the example}
-Here's \file{psBuffer.h}:
-\begin{verbatim}
-#if !defined(PS_BUFFER_H)               /* here's the insides of psBuffer.h */
-#define PS_BUFFER_H
-#define PS_BUFSIZE 128                  // Size for I/O buffers
-
-typedef struct {
-    char buf[PS_BUFSIZE];               // buffer
-    int n;                              // number of bytes in buffer
-} psBuffer;
-
-psBuffer *psBufferAlloc(void);
-void psBufferFree(psBuffer *buf,         // buffer to delete
-                 int deep);             // NOTUSED. Do a deep delete
-
-void psBufferAppend(psBuffer *restrict buf, // psBuffer to append to
-                    const char *restrict str); // string to add
-
-#endif
-\end{verbatim}
-
 And here's the C source; \file{psUtils.h} provides \code{psAlloc/psFree}.
 
@@ -1218 +1197 @@
 %------------------------------------------------------------------------------
 
-\section{Departures from Sun Java Coding Standards}
-
-Apart from changes required by our use of C99 rather than Java,
-this document differs from the original Sun-Java standard in
-two sorts of ways; additions and changes.
-
-\subsection{ Additions to the Sun-Java standards}
-
-\begin{itemize}
-\item
-    Naming convention for include files
-
-\item
-  Added naming conventions for constructors, destructors, and conversion
-  subroutines.
-
-\item
-  Specified that the `output' argument should come \emph{first}.
-
-\item
-  Added conventional comments for unused arguments and unreachable
-  statements (conforming to Doxygen's conventions).
-
-\item
-  Specified that subroutines taking no arguments should be explicitly
-  specified as \code{(void)} (avoiding complaints on some compilers,
-  e.g. on SGIs).
-
-\item
-  Added rules on typedefing structs, and on struct tags.
-
-\end{itemize}
-
-\subsection{Departures from the Sun-Java standards}
-
-\begin{itemize}
-
-\item
-  We break lines \emph{after} (not before) an operator.
-
-\item
-  We don't specify any special indentation for continued logical
-  expressions within an \code{if} clause.
-
-\item
-  Specify that \code{case/break} statements should be indented
-  by half an indent (2 spaces)
-
-\item
-  Comments need not be preceeded by a blank line
-
-\item
-  The restriction on only declaring variables at the top of blocks (including
-  \code{for} loops has been somewhat relaxed.
-
-\item
-  Relaxed the `only one statement per line' rule a little.
-
-\item
-  High-precedence binary operators (\code{*}, \code{/}, \code{%} and above)
-    should \emph{not} be surrounded by whitespace.
-
-\item
-  The line-length limit has been changed from 80 to 110 characters.
-
-\item
-  Relaxed wording to allow parentheses to be omitted when the precedence
-  is well known and unambiguous.
-
-\end{itemize}
-
-%------------------------------------------------------------------------------
-
-\section{How to Achieve This Style in Emacs}
-  \label{dot_emacs}
-
-\textit{This section is provided for your convenience; it is, of course,
-not part of the coding standards.}
-
-The easiest way to use these conventions while writing code using
-emacs is to get \file{panstarrs.el} from \code{cvs} with the command
-\begin{verbatim}
-  cvs -d poiserver0.ifa.hawaii.edu:/usr/local/cvs/repositories/pan-starrs co Templates
-\end{verbatim}
-and then grab \file{Templates/panstarrs.el}.  Then add:
-
-\begin{verbatim}
-(load-file "/home/you/Templates/panstarrs.el")
-(add-to-list 'auto-mode-alist (cons "\\.[ch]$" 'panstarrs-c-mode))
-\end{verbatim}                          % $ % match that $ for emacs
-to your \file{.emacs} file; this will use \code{panstarrs-c-mode}
-for all \file{.c} and \file{.h} files.
-
-If you want to
-\begin{itemize}
-  \item use C99-style comments (i.e. \code{//} to end of line)
-  \item have your emacs window set to 110 characters wide
-  \item somewhat improve (or spoil?) the handling of re-indenting comments
-\end{itemize}
-add one or more of these \code{add-hook} commands to your \file{.emacs} file too:
-\begin{verbatim}
-(add-hook 'panstarrs-c-mode-hook 'panstarrs-c99-comments)
-(add-hook 'panstarrs-c-mode-hook 'panstarrs-set-width)
-(add-hook 'panstarrs-c-mode-hook
-          '(lambda ()
-             (set (make-variable-buffer-local 'comment-indent-subroutine)
-                  'panstarrs-comment-indent)))
-\end{verbatim}
-          
 \section{How to Achieve This Style with Astyle}
 \label{astyle}