Changeset 925


Ignore:
Timestamp:
Jun 13, 2012 5:43:05 PM (10 years ago)
Author:
jemian
Message:

use new SPEC triple-quoted strings to identify ReST text for documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • specdomain/src/round1/test/testbarrier.mac

    r911 r925  
    33# sample file to test sphinx documentation of SPEC macro files
    44
    5 #**
    6 # This file contains SPEC macro fragments to test various
    7 # parts of the SPHINX documentation builder.
    8 
     5"""
    96###############################################################################
    10 #        User macros to configure spec with the Image Server program
     7       User macros to configure spec with the Image Server program
    118###############################################################################
     9
     10This file contains SPEC macro fragments to test various
     11parts of the SPHINX documentation builder.
     12"""
    1213
    1314def ccdhelp '
     
    2223
    2324#==============================================================================
    24 #**
    25 # common/shutter
    26 # ==============
    27 #
    28 # NAME
    29 #   shutter.mac
    30 #
    31 # SUMMARY
    32 #   Commands to control a fast photon shutter.
    33 #
    34 # DESCRIPTION
    35 #   The macro causes the fast photon shutter to be opened immediately prior to
    36 #   any count command, and closed again upon its completion. A configurable
    37 #   delay time assures that the shutter is fully open before issuing the
    38 #   count command.
    39 #
    40 #   The photon shutter is controlled via an EPICS binary output channel, and
    41 #   the shutter status is optionally monitored via a binary input channel (in
    42 #   which case the delay time is not used, but the monitor signal is used to
    43 #   check for completion of the opening process).
    44 #
    45 # AUTHOR
    46 #   Christian M. Schlepuetz (CS, cschlep)
    47 #
    48 # CREATION DATE
    49 #   2004/11/06
    50 #
    51 # COPYRIGHT
    52 #   Copyright 2006-2011 by the above authors (see AUTHOR/AUTHORS)
    53 #
    54 #   This program is free software: you can redistribute it and/or modify
    55 #   it under the terms of the GNU General Public License as published by
    56 #   the Free Software Foundation, either version 3 of the License, or
    57 #   (at your option) any later version.
    58 #
    59 #   This program is distributed in the hope that it will be useful,
    60 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
    61 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    62 #   GNU General Public License for more details.
    63 #
    64 #   You should have received a copy of the GNU General Public License
    65 #   along with this program.  If not, see http://www.gnu.org/licenses/.
    66 #
    67 # VERSION::
    68 #
    69 #   $. Date: 2010-11-04 19:06:06 -0400 (Thu, 04 Nov 2010) $
    70 #   $. Author: cschlep $
    71 #   $. URL: file:///data/svn/software/spec/trunk/common/shutter.mac $
    72 #   $. Revision: 17 $
    73 #
    74 # DEPENDENCIES
    75 #   Chained macro definitions affected by this macro:
    76 #   - user_precount
    77 #   - user_getcounts
    78 #   - cleanup_always
    79 #
    80 # HISTORY
    81 #   2004/11/06 (CS):
    82 #   
    83 #   - modified the first original version to comply with naming and format
    84 #     conventions
    85 #   - implemented help-file support and wrote help texts.
    86 #     2010/03/30 (CS):
    87 #   - added the following global variables to make macro more easily portable::
    88 #
    89 #           SHUTTER_CONTROL_PV      # EPICS PV name for the shutter control (bo)
    90 #           SHUTTER_CONTROL_OPEN    # EPICS control value for open shutter
    91 #           SHUTTER_CONTROL_CLOSED  # EPICS control value for closed shutter
    92 #           SHUTTER_STATUS_PV       # EPICE PV name for the shutter status (bi)
    93 #           SHUTTER_STATUS_OPEN     # EPICS status value for open shutter
    94 #           SHUTTER_STATUS_CLOSED   # EPICS status value for closed shutter
    95 #           SHUTTER_IS_ON           # flag for automatic shutter control
    96 #           SHUTTER_SLEEP_TIME      # SPEC sleep time after opening shutter
    97 #
    98 #   2010/07/23 (CS):
    99 #   - added SVN keywords (replacing CVS keywords)
    100 #
    101 #   2011/12/19 (CS):
    102 #   - reformatted code documentation to work with ROBODoc
    103 #   - added shutter_setup with following internal macros:
    104 #
    105 #     * _shutter_print_setup
    106 #     * _shutter_set_option
    107 #     * _clear_screen
    108 #
    109 #   - replaced SHUTTER_STATUS* with SHUTTER_MONITOR*
    110 #   - replaced global variables _OPEN with _OPEN_VAL and
    111 #     _CLOSED with _CLOSED_VAL
    112 #
     25"""
     26common/shutter
     27==============
     28
     29NAME
     30   shutter.mac
     31
     32SUMMARY
     33   Commands to control a fast photon shutter.
     34
     35DESCRIPTION
     36   The macro causes the fast photon shutter to be opened immediately prior to
     37   any count command, and closed again upon its completion. A configurable
     38   delay time assures that the shutter is fully open before issuing the
     39   count command.
     40
     41   The photon shutter is controlled via an EPICS binary output channel, and
     42   the shutter status is optionally monitored via a binary input channel (in
     43   which case the delay time is not used, but the monitor signal is used to
     44   check for completion of the opening process).
     45
     46AUTHOR
     47   Christian M. Schlepuetz (CS, cschlep)
     48
     49CREATION DATE
     50   2004/11/06
     51
     52COPYRIGHT
     53   Copyright 2006-2011 by the above authors (see AUTHOR/AUTHORS)
     54
     55   This program is free software: you can redistribute it and/or modify
     56   it under the terms of the GNU General Public License as published by
     57   the Free Software Foundation, either version 3 of the License, or
     58   (at your option) any later version.
     59
     60   This program is distributed in the hope that it will be useful,
     61   but WITHOUT ANY WARRANTY; without even the implied warranty of
     62   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     63   GNU General Public License for more details.
     64
     65   You should have received a copy of the GNU General Public License
     66   along with this program.  If not, see http://www.gnu.org/licenses/.
     67
     68VERSION::
     69
     70   $. Date: 2010-11-04 19:06:06 -0400 (Thu, 04 Nov 2010) $
     71   $. Author: cschlep $
     72   $. URL: file:///data/svn/software/spec/trunk/common/shutter.mac $
     73   $. Revision: 17 $
     74
     75DEPENDENCIES
     76   Chained macro definitions affected by this macro:
     77   - user_precount
     78   - user_getcounts
     79   - cleanup_always
     80
     81HISTORY
     82   2004/11/06 (CS):
     83   
     84           - modified the first original version to comply with naming and format
     85             conventions
     86           - implemented help-file support and wrote help texts.
     87             2010/03/30 (CS):
     88           - added the following global variables to make macro more easily portable::
     89       
     90                    SHUTTER_CONTROL_PV      # EPICS PV name for the shutter control (bo)
     91                    SHUTTER_CONTROL_OPEN    # EPICS control value for open shutter
     92                    SHUTTER_CONTROL_CLOSED  # EPICS control value for closed shutter
     93                    SHUTTER_STATUS_PV       # EPICE PV name for the shutter status (bi)
     94                    SHUTTER_STATUS_OPEN     # EPICS status value for open shutter
     95                    SHUTTER_STATUS_CLOSED   # EPICS status value for closed shutter
     96                    SHUTTER_IS_ON           # flag for automatic shutter control
     97                    SHUTTER_SLEEP_TIME      # SPEC sleep time after opening shutter
     98
     99   2010/07/23 (CS):
     100           - added SVN keywords (replacing CVS keywords)
     101
     102   2011/12/19 (CS):
     103           - reformatted code documentation to work with ROBODoc
     104           - added shutter_setup with following internal macros:
     105       
     106             * _shutter_print_setup
     107             * _shutter_set_option
     108             * _clear_screen
     109       
     110           - replaced SHUTTER_STATUS* with SHUTTER_MONITOR*
     111           - replaced global variables _OPEN with _OPEN_VAL and
     112             _CLOSED with _CLOSED_VAL
     113"""
    113114#==============================================================================
    114115
     
    155156
    156157#------------------------------------------------------------------------------
    157 #**
    158 # shutter/sh_help, shutter_help
    159 # =============================
    160 #
    161 # Displays the shutter help text.
    162 #
    163 # usage::
    164 #
    165 #   > sh_help
    166 #
    167 # .. note::
    168 #   The help text is generated by simply displaying the text file
    169 #   shutter_mac.txt, which should reside in the same directory as shutter.mac.
    170 #   If the file does not exist, a generic help text is shown.
    171158
    172159def shutter_help 'sh_help'
    173160
    174161def sh_help '{
    175 #   =======
     162        """
     163        sh_help, shutter_help
     164        =============================
     165       
     166        Displays the shutter help text.
     167       
     168        usage::
     169       
     170           > sh_help
     171       
     172        .. note::
     173           The help text is generated by simply displaying the text file
     174           ``shutter_mac.txt``, which should reside in the same directory as ``shutter.mac``.
     175           If the file does not exist, a generic help text is shown.
     176        """
    176177
    177178  unix (sprintf ("dirname %s", SHUTTER_MAC), _1)
Note: See TracChangeset for help on using the changeset viewer.