Changeset 93 for trunk/SRC/Utilities/isadirectory.pro

Timestamp:

06/07/06 19:12:14 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Calendar and Utilities *.pro files for bet
ter idldoc output

File:

• trunk/SRC/Utilities/isadirectory.pro (modified) (3 diffs)

trunk/SRC/Utilities/isadirectory.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:isadirectory
-;
-; PURPOSE:check if a directory exists and make sure that it ends 
+; check if a directory exists and make sure that it ends 
 ;         with the directory separator mark.
 ;
-; CATEGORY: io
+; @categories io
 ;
-; CALLING SEQUENCE: directory=isadirectory([dirname])
-; 
-; INPUTS:optional:a proposed directory. If neither dirname 
+; @param directoryin {in}{optional} a proposed directory. If neither dirname 
 ;        input parameter of IODIRECTORY keyword are defined,
 ;        the ask the user to choose a directory.
 ;
-; KEYWORD PARAMETERS:
+; @keyword IODIRECTORY a proposed directory
 ;
-;     IODIRECTORY:a proposed directory
+; @keyword TITLE the title of the window
 ;
-;     TITLE = the title of the window
+; @file_comments  all dialog_pickfile keywords (like filter) can be used.
 ;
-;     all dialog_pickfile keywords (like filter)
+; @returns the directory name
 ;
-; OUTPUTS: the directory name
-;
-; COMMON BLOCKS:none
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples 
 ;
 ;    IDL> print, !dir
@@ -40 +28 @@
 ;    IDL> print, isadirectory(!dir+'notgood')
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      June 28, 2000
 ; June 2005: Sebastien Masson: cleaning, use for file_* functions
@@ -72 +60 @@
 ;
 END
-
-
-
-