Mercurial > hg > octave-lyh
changeset 12489:ac3bdc27734e
Clarify in manual that the mkoctfile examples are in C++
| author | Jordi Gutiérrez Hermoso <jordigh@gmail.com> |
|---|---|
| date | Tue, 01 Mar 2011 07:43:44 -0600 |
| parents | bea828c03969 |
| children | 30f2a3b1d236 |
| files | doc/ChangeLog doc/interpreter/dynamic.txi |
| diffstat | 2 files changed, 14 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2011-03-01 Jordi Gutiérrez Hermoso <jordigh@gmail.com> + + * interpreter/dynamic.txi: Make it clear that <octave/oct.h> is + a C++ source file and refer to the section where other languages + are discussed. + 2010-02-28 Rik <octave@nomad.inbox5.com> * interpreter/numbers.txi: Add isrow, iscolumn functions to manual.
--- a/doc/interpreter/dynamic.txi +++ b/doc/interpreter/dynamic.txi @@ -99,7 +99,7 @@ @DOCSTRING(mkoctfile) -Consider the short example: +Consider the short C++ example: @example @group @@ -108,10 +108,13 @@ @end example This example although short introduces the basics of writing a C++ -function that can be dynamically linked to Octave. The easiest way to -make available most of the definitions that might be necessary for an -oct-file in Octave is to use the @code{#include <octave/oct.h>} -header. +function that can be dynamically linked to Octave. The easiest way to +make available most of the definitions that might be necessary for a C++ +oct-file in Octave is to use the @code{#include <octave/oct.h>} header. +Note that @file{octave/oct.h} is a C++ header and cannot be directly +@code{#include}'ed in a C source file, nor any other language. What +follows is mostly C++, with a discussion of other languages in section +@ref{Calling External Code from Oct-Files}. The macro that defines the entry point into the dynamically loaded function is @w{@code{DEFUN_DLD}}. This macro takes four arguments, these being