summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_extern.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_extern.rst')
-rw-r--r--docs/nspr/reference/pr_extern.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_extern.rst b/docs/nspr/reference/pr_extern.rst
new file mode 100644
index 0000000000..64d38654b6
--- /dev/null
+++ b/docs/nspr/reference/pr_extern.rst
@@ -0,0 +1,30 @@
+PR_EXTERN
+=========
+
+Used to define the prototypes for functions or variables that are to be
+exported from a shared library.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prtypes.h>
+
+ PR_EXTERN(type)prototype
+
+
+Description
+-----------
+
+:ref:`PR_EXTERN` is used to define externally visible routines and globals.
+For syntax details for each platform, see
+`prtypes.h <https://dxr.mozilla.org/mozilla-central/source/nsprpub/pr/include/prtypes.h>`__.
+The macro includes the proper specifications to declare the target
+``extern`` and set up other required linkages.
+
+.. warning::
+
+ **Warning**: Some platforms do not allow the use of the underscore
+ character (_) as the first character of an exported symbol.