Skip to content

Commit

Permalink
docs: typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Helge Mathee committed Oct 6, 2014
1 parent 59577e3 commit 9068cf9
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions FabricSplice.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,16 @@ Indices and Tables
Introduction
============
.. note:: You can find the source code for the SpliceAPI here: http://github.com/fabric-engine/SpliceAPI
The Fabric:Splice C/C++ API, referred to as :dfn:`SPLICECAPI` in this document, is an abstraction layer to the `Fabric Core CAPI <http://documentation.fabric-engine.com/CreationPlatform/latest/HTML/CAPIProgrammingGuide/index.html>`_. The SPLICEAPI provides a simpler way to integrate Fabric Core based functionality into C/C++ hosts applications and wraps lots of the rudimentary facilities. The :dfn:`SPLICECAPI` also supports additional facilities, such as persistence, for example.
Aside from this documentation API you can find a general descriptiong of how to integrate Splice into a host application here: :ref:`SPLICEINTEGRATION`. This also includes recommendations for build settings and C defines.
Aside from this documentation API you can find a general description of how to integrate Splice into a host application here: :ref:`SPLICEINTEGRATION`. This also includes recommendations for build settings and C defines.
One API, Two Interfaces
-----------------------
:dfn:`SPLICECAPI` is implemented as a pure C API with a thin, inlined C++ interface that makes it easier to use in C++ applications. This is done to minimize linking issues, as the C linking interface on the platforms that Fabric:Splice supports is much more controlled than the C++ linking interface. The C++ interface is thus purely a C++ programmer convience; however, it is a big programmer convenience, and as such it is recommended that you use the C++ language interface when possible. Both interfaces link with exactly the same shared library (DLL).
:dfn:`SPLICECAPI` is implemented as a pure C API with a thin, inlined C++ interface that makes it easier to use in C++ applications. This is done to minimize linking issues, as the C linking interface on the platforms that Fabric:Splice supports is much more controlled than the C++ linking interface. The C++ interface is thus purely a C++ programmer convenience; however, it is a big programmer convenience, and as such it is recommended that you use the C++ language interface when possible. Both interfaces link with exactly the same shared library (DLL).
Since the host application targeted with the :dfn:`SPLICECAPI` are mainly C++ based, when discussing the API in this guide, we will only present the C++ version.
Expand Down Expand Up @@ -949,7 +951,7 @@ Class Outline
FabricSplice::Scripting
===============================
The Scripting class provides static methods for parsing script arguments. This can be useful within Splice integrations. Options are provided as json strings typically, and the following helper functions simlpify parsing these.
The Scripting class provides static methods for parsing script arguments. This can be useful within Splice integrations. Options are provided as json strings typically, and the following helper functions simplify parsing these.
Class Outline
---------------------------------
Expand Down Expand Up @@ -1007,7 +1009,7 @@ Example
printf("Splice Error %s\n", e.what());
}
It's recommended to wrap the try and catch calles into macros, so that you can deploy them easily anywhere you use the :dfn:`SPLICECAPI`.
It's recommended to wrap the try and catch calls into macros, so that you can deploy them easily anywhere you use the :dfn:`SPLICECAPI`.
Class Outline
---------------------------------
Expand Down

0 comments on commit 9068cf9

Please sign in to comment.