diff --git a/SWIG/Doc/internals.html b/SWIG/Doc/internals.html index 08785df0f..65b9e5afe 100644 --- a/SWIG/Doc/internals.html +++ b/SWIG/Doc/internals.html @@ -57,7 +57,7 @@ beazley@cs.uchicago.edu
  • 10.3 Underscore Folding
  • 10.4 Typemaps
  • 10.5 Smobs -
  • 10.5 Exception Handling +
  • 10.6 Exception Handling
  • 11. Python Support
  • 12. Perl Support @@ -938,7 +938,8 @@ for specifying local variable declarations and argument conversions.

    10. Guile Support

    -Revised: Thien-Thi Nguyen (July 23, 2000) +Revised: Matthias Köppe (August 30, 2000) +

    This section details guile-specific support in SWIG. @@ -1064,16 +1065,14 @@ and value.

    To construct a Scheme object from a C pointer, the wrapper code calls -the function SWIG_Guile_MakePtr_Str(), passing both a -mangled type string and a pretty type string. The former is looked up -in the type table to get the type index to store in the upper half of -the CAR. If the type is new, it is appended to type table. +the function SWIG_Guile_MakePtr(), passing a pointer to a +struct representing the pointer type. The type index to store in the +upper half of the CAR is read from this struct.

    To get the pointer represented by a smob, the wrapper code calls the -function SWIG_Guile_GetPtr_Str, passing the mangled name -of the expected pointer type, which is used for looking up the type in -the type table and accessing the list of compatible types. If the +function SWIG_Guile_GetPtr, passing a pointer to a struct +representing the expected pointer type. If the Scheme object passed was not a SWIG smob representing a compatible pointer, a wrong-type-arg exception is raised. @@ -1102,20 +1101,46 @@ mapping: The default when not specified here is to use "swig-error". See Lib/exception.i for details. + +

    10.7 Guile procedure documentation

    + + +

    If invoked with the command-line option -procdoc +file, SWIG creates documentation strings for the +generated wrapper functions, describing the procedure signature and +return value, and writes them to file. + +

    You need to register the generated documentation file with Guile +like this: +

    +(use-modules (ice-9 documentation))
    +(set! documentation-files 
    +      (cons "file" documentation-files))
    +
    +This requires Guile 1.4 or later. + +

    Documentation strings can be configured using the Guile-specific +typemaps indoc, outdoc, +argoutdoc, varindoc, and +varoutdoc. See Lib/guile/typemaps.i for +details. + + + -

    10. Python Support

    +

    11. Python Support

    [TODO] -

    10. Perl Support

    +

    12. Perl Support

    [TODO] -

    10. Java Support

    +

    13. Java Support

    [TODO]