Changeset 104 for trunk/SRC/Postscript/openps.pro

Timestamp:

06/12/06 14:54:03 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation

File:

• trunk/SRC/Postscript/openps.pro (modified) (2 diffs)

trunk/SRC/Postscript/openps.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:openps
 ;
-; PURPOSE:switch to postcript mode and define it
+; @file_comments switch to postcript mode and define it
 ;
-; CALLING SEQUENCE:openps[,nameps]
-;
-; OPTIONAL INPUT:
-;        nameps: name of the postscript file. Extension '.ps' is added
+; @param namepsin {in}{optional} name of the postscript file. Extension '.ps' is added
 ;                if missing. It will be stored in the psdir directory.
 ;
-; KEYWORD PARAMETERS:
-;
-;        FILENAME: to define the name of the postcript file through
+; @keyword FILENAME to define the name of the postcript file through
 ;                  a keyword rather than with nameps inut argument
 ;                  (in this case the keyword can be pass through 
 ;                  different routines via _extra keyword).
 ;
-;        INFOWIDGET: If INFOWIDGET is present, it specifies a named
+; @keyword INFOWIDGET If INFOWIDGET is present, it specifies a named
 ;             variable into which the id of the widget giving informations
 ;             about the postscript creation is stored as a long integer.
 ;             This id is needed by close ps to kill the information widget.
 ;
-;        KEEP_PFONT: activate to suppress the modification of !p.font
+; @keyword KEEP_PFONT activate to suppress the modification of !p.font
 ;            (by defaut we force  !p.font = 0  to make smaller postscripts)
-;        KEEPPFONT: same as keep_pfont
+; @keyword KEEPPFONT same as keep_pfont
 ;
-;        LIGHTNESS: a scalar used to change the Lightness of the color
+; @keyword LIGHTNESS a scalar used to change the Lightness of the color
 ;            palette to be abble to adjust according to the printer we use,
 ;            the media (paper or slide)... 
@@ -35 +29 @@
 ;                         > 1 to get darker colors
 ;
-;        _EXTRA: used to pass any keyword to device procedure.
+; @keyword _EXTRA: used to pass any keyword to device procedure.
 ;  
-; COMMON BLOCKS: cm_4ps
+; uses cm_4ps
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       21/12/98
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
+; 21/12/98
 ; 1/2/98: ajout de nameps en input
 ; 1/9/1999: ajout du mot cle FILENAME et du widget