doc/src/user/raise_proto.im

   1 .** vim: sw=4 ts=4 et :
   2 .if false
   3 ==================================================================================
   4     Copyright (c) 2020 Nokia
   5     Copyright (c) 2020 AT&T Intellectual Property.
   6
   7    Licensed under the Apache License, Version 2.0 (the "License");
   8    you may not use this file except in compliance with the License.
   9    You may obtain a copy of the License at
  10
  11        http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18 ==================================================================================
  19 .fi
  20
  21
  22 .** we cant generate ncie tables it seems in any mark* language
  23 .** so do nice formatting in pfm, and just embed the protos
  24 .** for the bloody ascii based things.
  25
  26 .ca start proto.ca
  27 &ex_end
  28   bool Raise( );
  29   bool Raise( int severity, int problem, std::string info );
  30   bool Raise( int severity, int problem, std::string info,
  31               std::string addional_info );
  32   bool Raise_again( );
  33 &ex_end
  34 .ca end
  35
  36 .if pfm
  37
  38
  39 &beg_table( 5.25i .3i : 80,15 )
  40 &col
  41 .im proto.ca
  42 &ex_start
  43 (1)
  44 (2)
  45 (3)
  46
  47 (4)
  48 &ex_end
  49 &end_table
  50
  51
  52 .ei
  53 .im proto.ca
  54 .fi
  55
  56 &fig_cen(The Raise function prototypes.)
  57 &space