Add note on using inline keyword from shared header files

Author: jjallaire

ChangeLog

@@ -1,7 +1,12 @@
+2015-02-19  JJ Allaire  <[email protected]>
+
+        * vignettes/Rcpp-attributes.Rnw: Add note on using inline
+        keyword from shared header files.
+
 2015-02-17  JJ Allaire  <[email protected]>
 
         * vignettes/Rcpp-attributes.Rnw: Update attributes vignette
-        with docs on new features,
+        with docs on new features.
 
 2015-02-14  JJ Allaire  <[email protected]>
 

vignettes/Rcpp-attributes.Rnw

@@ -428,7 +428,7 @@ shared functions, classes, enums, etc. For example:
 #ifndef __UTILITIES__
 #define __UTILITIES__
 
-double timesTwo(double x) {
+inline double timesTwo(double x) {
     return x * 2;
 }
 
@@ -440,6 +440,8 @@ that code is not included more than once in a source file. You should
 use an include guard and be sure to pick a unique name for the corresponding
 \texttt{\#define}. 
 
+Also note the use of the \code{inline} keyword preceding the function. This isn't necessary for \code{sourceCpp} however if you are working on an R package then it's important to ensure that there are not multiple definitions of functions included from header files. Classes fully defined in header files automatically have inline semantics so don't require this treatment.
+
 To use this code in a source file you'd just include
 it based on it's relative path (being sure to use \texttt{"} as the 
 delimiter to indicate a local file reference). For example: