Changeset 3207 for src/Pugs/Run/Args.hs

Timestamp:

05/14/05 09:49:53 (4 years ago)

Author:

bsb

svk:copy_cache_prev:

4718

Message:

haddock for canonicalArgs

Files:

• src/Pugs/Run/Args.hs (modified) (3 diffs)

src/Pugs/Run/Args.hs

@@ -18 +18 @@
 -}
 
+-- | Command line argument parser for pugs.
 module Pugs.Run.Args (canonicalArgs
 , gatherArgs
@@ -26 +27 @@
 import Pugs.Internals
 
+{- | 
+  Convert command line arguments into canonical form for 
+  'Pugs.Run.runWithArgs'.  The switch ordering is defined
+  by compareArgs and is currently:
+
+  > (-h -v -V) (-I) (-d) (-w) (-c) (-C) (--external) (-M) (-n -p) (-l -0 -e other)
+
+  Args -M, -n and -p are converted to -e scripts by joinDashE.
+-}
 canonicalArgs :: [String] -> [String]
 canonicalArgs x = concatMap procArg
@@ -67 +77 @@
 
 {-
+  Enforce a canonical order of command line switches.  Currently this is:
 
-  compareArgs enforces a canonical order of command line switches.
-  Currently this is:
-
-    (-h -v -V) (-I) (-d) (-w) (-c) (-C) (--external) (-M) (-n -p) (-l -0 -e other)
+  > (-h -v -V) (-I) (-d) (-w) (-c) (-C) (--external) (-M) (-n -p) (-l -0 -e other)
 
   This makes pattern matching more convenient
 
   Backwards incompatible changes:
-    -p and -n autochomp.
-    -p uses say() instead of print()
 
+   *  -p and -n autochomp.
+
+   *  -p uses say() instead of print()
 -}