Changeset 334

Timestamp:

11/27/07 14:51:49 (5 years ago)

Author:

mgalloy

Message:

Turned off DEBUG. Fixed typo in CSS for code (reported by Piper). Added HELP and VERSION keywords per Piper's request.

Location:

trunk/idldoc/src

Files:

• doc_system__define.pro (modified) (3 diffs)
• idldoc.pro (modified) (3 diffs)
• resources/main.css (modified) (1 diff)

trunk/idldoc/src/doc_system__define.pro

@@ -247 +247 @@
 
     
-  message, 'IDLDOC: ' + msg, /noname
+  message, msg, /noname
 end
 
@@ -281 +281 @@
   
   if (~self.quiet && ~self.silent) then print, msg
+end
+
+
+;+
+; Print basic help message.
+;-
+pro doc_system::printHelp
+  compile_opt strictarr
+  
+  msg = ['Calling syntax: ', $
+         '', $
+         '  IDL> idldoc, ROOT=root, OUTPUT=output', $
+         '', $
+         'where the ROOT keyword specifies a directory hierarchy to', $
+         'document and the OUTPUT keyword specifies an output location.', $
+         '', $
+         'See the help for more information about other keywords.']
+  
+  self->print, transpose(msg)
 end
 
@@ -921 +940 @@
                            preformat=preformat, browse_routines=browseRoutines, $
                            template_prefix=templatePrefix, $
-                           template_location=templateLocation                          
+                           template_location=templateLocation, $
+                           help=help, version=version                      
   compile_opt strictarr
   
   self.version = idldoc_version()
+  
+  if (keyword_set(version)) then begin
+    self->print, 'IDLdoc ' + self.version
+    return, 0
+  endif
+  
+  if (keyword_set(help)) then begin
+    self->printHelp
+    return, 0
+  endif
   
   ; check root directory

trunk/idldoc/src/idldoc.pro

@@ -64 +64 @@
 ;    error : out, optional, type=long
 ;       error code from run; 0 indicates no error
+;    help : in, optional, type=boolean
+;       if set, print out a help message instead of running IDLdoc
+;    version : in, optional, type=boolean
+;       if set, print the IDLdoc version instead of running IDLdoc
 ;-
 pro idldoc, root=root, $
@@ -88 +92 @@
             template_prefix=templatePrefix, $
             template_location=templateLocation, $
-            error=error
+            error=error, $
+            help=help, $
+            version=version
   compile_opt strictarr
 
   ; TODO: make sure to turn debug off before releasing
-  debug = 1B
+  debug = 0B
   origPath = !path
   
@@ -129 +135 @@
                    browse_routines=browseRoutines, $
                    template_prefix=templatePrefix, $
-                   template_location=templateLocation)
+                   template_location=templateLocation, $
+                   help=help, $
+                   version=version)
   
   !path = origPath

trunk/idldoc/src/resources/main.css

@@ -43 +43 @@
 
 /* code styles */
-code { font-family: Monaco; "Courier New", Courier, monospace; }
+code { font-family: Monaco, "Courier New", Courier, monospace; }
 code.listing { white-space: pre; display: block; padding: 0.5em 3em 0.5em 3em; font-size: 90%; }
 code.source { white-space: pre; display: block; font-size: 90%; }