RdocException              package:R.oo              R Documentation

_R_d_o_c_E_x_c_e_p_t_i_o_n _a_r_e _t_h_r_o_w_n _b_y _t_h_e _R_d_o_c _c_o_m_p_i_l_e_r

_D_e_s_c_r_i_p_t_i_o_n:

     Package:  R.oo 
      *Class RdocException*

     'Object'
      '~~|'
      '~~+--''try-error'
      '~~~~~~~|'
      '~~~~~~~+--''condition'
      '~~~~~~~~~~~~|'
      '~~~~~~~~~~~~+--''error'
      '~~~~~~~~~~~~~~~~~|'
      '~~~~~~~~~~~~~~~~~+--''simpleError'
      '~~~~~~~~~~~~~~~~~~~~~~|'
      '~~~~~~~~~~~~~~~~~~~~~~+--''Exception'
      '~~~~~~~~~~~~~~~~~~~~~~~~~~~|'
      '~~~~~~~~~~~~~~~~~~~~~~~~~~~+--''RdocException'

     *Directly known subclasses:*


     public static class *RdocException*
      extends Exception

     RdocException are thrown by the Rdoc compiler when it fails to
     generate a Rd file from an Rdoc comment.

_U_s_a_g_e:

     RdocException(..., source=NULL)

_A_r_g_u_m_e_n_t_s:

     ...: Any arguments accepted by 'Exception'

  source: Object specifying the source where the Rdoc error occured.
          This is commonly a filename 'character' string.

     .

_F_i_e_l_d_s _a_n_d _M_e_t_h_o_d_s:

     *Methods:*

         'as.character'  Gets a character string representing of the RdocException.
         'getSource'     Gets the source of the exception.

     *Methods inherited from Exception*:
      as.character, getCall, getLastException, getMessage,
     getStackTrace, getWhen, print, printStackTrace, throw

     *Methods inherited from error*:
      as.character, throw

     *Methods inherited from condition*:
      as.character, conditionCall, conditionMessage, print

     *Methods inherited from Object*:
      $, $<-, [[, [[<-, as.character, attach, attachLocally,
     clearCache, clone, detach, equals, extend, finalize, gc,
     getEnvironment, getFields, getInstanciationTime,
     getStaticInstance, hasField, hashCode, ll, load, objectSize,
     print, save

_A_u_t_h_o_r(_s):

     Henrik Bengtsson (<URL: http://www.braju.com/R/>)

_S_e_e _A_l_s_o:

     For detailed information about exceptions see 'Exception'.

