From d38ede55c5304f3d934cb7049f015f534768792b Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Wed, 11 Mar 2020 22:37:02 -0500 Subject: [PATCH] More generator doc updates --- src/tools/makeAPIheader.pl | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/tools/makeAPIheader.pl b/src/tools/makeAPIheader.pl index db118b022..db043d8cb 100644 --- a/src/tools/makeAPIheader.pl +++ b/src/tools/makeAPIheader.pl @@ -53,6 +53,11 @@ library implementation code to define the C macro in between the import and export headers. The order of including header files no longer matters when using this approach. +For libraries that contain EPICS record, device, driver or link support and use +the epicsExport.h macros to publish the associated support entry table for the +IOC to locate, switching from shareLib.h to a generated API header file is not +recommended. The old approach is simpler in these cases. + =head1 USING WITH EPICS In a Makefile that is building a DLL or shared library, set the variable @@ -76,8 +81,9 @@ indicated by setting the C variable to the API stem, like this: Com_API = libCom Then in each header file that declares a function, global variable or C++ -class or method to be exported by the library, decorate those declarations -with the all-uppercase keyword C as in these examples: +class or method to be exported by the library, include the generated header +file and then decorate those declarations with the all-uppercase keyword +C as in these examples: LIBCOM_API void epicsExit(int status); LIBCOM_API int asCheckClientIP;