From 14e205a735659b4a63d518dfb996afe421b83996 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Wed, 2 Feb 2022 17:19:51 +0000 Subject: [PATCH] Bug 1753127 - NSPR doc: fix the typos, warnings and nbsp; r=kaie Depends on D137612 Differential Revision: https://phabricator.services.mozilla.com/D137650 --- docs/nspr/about_nspr.rst | 10 ------ docs/nspr/creating_a_cookie_log.rst | 8 ----- docs/nspr/index.rst | 4 --- docs/nspr/nonblocking_io_in_nspr.rst | 2 -- docs/nspr/nspr_build_instructions.rst | 4 --- docs/nspr/nspr_contributor_guide.rst | 32 ++----------------- .../nspr/optimizing_applications_for_nspr.rst | 2 -- .../reference/anonymous_shared_memory.rst | 2 +- docs/nspr/reference/cached_monitors.rst | 2 -- docs/nspr/reference/date_and_time.rst | 2 -- .../reference/dynamic_library_linking.rst | 9 ++---- ...ting_point_number_to_string_conversion.rst | 2 -- docs/nspr/reference/i_o_functions.rst | 2 +- docs/nspr/reference/index.rst | 2 -- docs/nspr/reference/introduction_to_nspr.rst | 8 ++--- docs/nspr/reference/logging.rst | 6 ++-- docs/nspr/reference/named_shared_memory.rst | 2 -- docs/nspr/reference/network_addresses.rst | 2 +- docs/nspr/reference/nspr_log_file.rst | 6 ++-- docs/nspr/reference/nspr_log_modules.rst | 12 +++---- docs/nspr/reference/pl_comparestrings.rst | 2 -- docs/nspr/reference/pl_comparevalues.rst | 2 -- docs/nspr/reference/pl_hashstring.rst | 4 --- docs/nspr/reference/pl_hashtableadd.rst | 4 --- docs/nspr/reference/pl_hashtabledestroy.rst | 3 -- .../pl_hashtableenumerateentries.rst | 4 --- docs/nspr/reference/pl_hashtablelookup.rst | 4 --- docs/nspr/reference/pl_hashtableremove.rst | 4 --- docs/nspr/reference/pl_newhashtable.rst | 4 --- docs/nspr/reference/pl_strcpy.rst | 4 --- docs/nspr/reference/pl_strdup.rst | 6 ---- docs/nspr/reference/pl_strfree.rst | 2 -- docs/nspr/reference/pl_strlen.rst | 3 -- docs/nspr/reference/plhashallocops.rst | 3 -- docs/nspr/reference/plhashcomparator.rst | 4 --- docs/nspr/reference/plhashentry.rst | 2 -- docs/nspr/reference/plhashenumerator.rst | 4 --- docs/nspr/reference/plhashfunction.rst | 3 -- docs/nspr/reference/plhashnumber.rst | 3 -- docs/nspr/reference/plhashtable.rst | 2 -- docs/nspr/reference/pr_abort.rst | 2 -- docs/nspr/reference/pr_accept.rst | 4 --- docs/nspr/reference/pr_acceptread.rst | 4 --- docs/nspr/reference/pr_access.rst | 3 -- docs/nspr/reference/pr_append_link.rst | 3 -- docs/nspr/reference/pr_assert.rst | 4 --- docs/nspr/reference/pr_atomicadd.rst | 6 +--- docs/nspr/reference/pr_atomicdecrement.rst | 4 --- docs/nspr/reference/pr_atomicincrement.rst | 4 --- docs/nspr/reference/pr_atomicset.rst | 4 --- docs/nspr/reference/pr_attachsharedmemory.rst | 3 -- docs/nspr/reference/pr_attachthread.rst | 4 --- docs/nspr/reference/pr_available.rst | 5 --- docs/nspr/reference/pr_available64.rst | 5 --- docs/nspr/reference/pr_bind.rst | 4 --- .../reference/pr_blockclockinterrupts.rst | 1 - docs/nspr/reference/pr_callback.rst | 2 -- docs/nspr/reference/pr_calloc.rst | 4 --- docs/nspr/reference/pr_callonce.rst | 2 -- docs/nspr/reference/pr_canceljob.rst | 3 -- docs/nspr/reference/pr_centermonitor.rst | 4 --- docs/nspr/reference/pr_cexitmonitor.rst | 4 --- docs/nspr/reference/pr_cleanup.rst | 3 -- docs/nspr/reference/pr_clearinterrupt.rst | 2 -- docs/nspr/reference/pr_clist_is_empty.rst | 3 -- docs/nspr/reference/pr_close.rst | 4 --- docs/nspr/reference/pr_closedir.rst | 5 --- docs/nspr/reference/pr_closefilemap.rst | 4 --- docs/nspr/reference/pr_closesemaphore.rst | 3 -- docs/nspr/reference/pr_closesharedmemory.rst | 3 -- docs/nspr/reference/pr_cnotify.rst | 4 --- docs/nspr/reference/pr_cnotifyall.rst | 4 --- docs/nspr/reference/pr_cnvtf.rst | 3 -- docs/nspr/reference/pr_connect.rst | 4 --- docs/nspr/reference/pr_connectcontinue.rst | 10 ++---- .../reference/pr_convertipv4addrtoipv6.rst | 6 ++-- docs/nspr/reference/pr_createfilemap.rst | 4 --- docs/nspr/reference/pr_createiolayerstub.rst | 4 --- docs/nspr/reference/pr_createpipe.rst | 4 --- docs/nspr/reference/pr_createthread.rst | 4 --- docs/nspr/reference/pr_createthreadpool.rst | 4 --- docs/nspr/reference/pr_cwait.rst | 4 --- docs/nspr/reference/pr_delete.rst | 6 +--- docs/nspr/reference/pr_delete_.rst | 4 --- docs/nspr/reference/pr_deletesemaphore.rst | 3 -- docs/nspr/reference/pr_deletesharedmemory.rst | 3 -- docs/nspr/reference/pr_destroycondvar.rst | 3 -- docs/nspr/reference/pr_destroylock.rst | 4 --- docs/nspr/reference/pr_destroymonitor.rst | 3 -- .../reference/pr_destroypollableevent.rst | 3 -- docs/nspr/reference/pr_detachsharedmemory.rst | 3 -- docs/nspr/reference/pr_detachthread.rst | 4 --- .../reference/pr_disableclockinterrupts.rst | 1 - docs/nspr/reference/pr_dtoa.rst | 5 --- docs/nspr/reference/pr_entermonitor.rst | 3 -- docs/nspr/reference/pr_enumerateaddrinfo.rst | 4 --- docs/nspr/reference/pr_enumeratehostent.rst | 4 --- docs/nspr/reference/pr_exitmonitor.rst | 4 --- docs/nspr/reference/pr_explodetime.rst | 4 --- .../reference/pr_exportfilemapasstring.rst | 4 --- docs/nspr/reference/pr_extern.rst | 2 -- docs/nspr/reference/pr_familyinet.rst | 2 -- docs/nspr/reference/pr_findsymbol.rst | 4 --- .../reference/pr_findsymbolandlibrary.rst | 4 --- docs/nspr/reference/pr_free.rst | 4 --- docs/nspr/reference/pr_freeaddrinfo.rst | 3 -- docs/nspr/reference/pr_freeif.rst | 4 --- docs/nspr/reference/pr_freelibraryname.rst | 4 --- docs/nspr/reference/pr_getaddrinfobyname.rst | 3 -- .../reference/pr_getcanonnamefromaddrinfo.rst | 3 -- docs/nspr/reference/pr_getconnectstatus.rst | 4 --- docs/nspr/reference/pr_getcurrentthread.rst | 3 -- .../nspr/reference/pr_getdefaultiomethods.rst | 3 -- docs/nspr/reference/pr_getdesctype.rst | 4 --- docs/nspr/reference/pr_geterror.rst | 2 -- docs/nspr/reference/pr_geterrortext.rst | 3 -- docs/nspr/reference/pr_geterrortextlength.rst | 2 -- docs/nspr/reference/pr_getfileinfo.rst | 5 --- docs/nspr/reference/pr_getfileinfo64.rst | 5 --- docs/nspr/reference/pr_gethostbyaddr.rst | 4 --- docs/nspr/reference/pr_gethostbyname.rst | 3 -- docs/nspr/reference/pr_getidentitieslayer.rst | 4 --- .../nspr/reference/pr_getinheritedfilemap.rst | 4 --- docs/nspr/reference/pr_getlayersidentity.rst | 3 -- docs/nspr/reference/pr_getlibraryname.rst | 4 --- docs/nspr/reference/pr_getlibrarypath.rst | 4 --- docs/nspr/reference/pr_getnameforidentity.rst | 4 --- docs/nspr/reference/pr_getopenfileinfo.rst | 5 --- docs/nspr/reference/pr_getopenfileinfo64.rst | 5 --- docs/nspr/reference/pr_getoserror.rst | 3 -- docs/nspr/reference/pr_getpeername.rst | 3 -- docs/nspr/reference/pr_getprotobyname.rst | 3 -- docs/nspr/reference/pr_getprotobynumber.rst | 3 -- docs/nspr/reference/pr_getrandomnoise.rst | 6 +--- docs/nspr/reference/pr_getsocketoption.rst | 3 -- docs/nspr/reference/pr_getsockname.rst | 3 -- docs/nspr/reference/pr_getspecialfd.rst | 4 --- docs/nspr/reference/pr_getthreadpriority.rst | 2 -- docs/nspr/reference/pr_getthreadprivate.rst | 4 --- docs/nspr/reference/pr_getthreadscope.rst | 2 -- docs/nspr/reference/pr_getuniqueidentity.rst | 4 --- docs/nspr/reference/pr_gmtparameters.rst | 4 --- docs/nspr/reference/pr_htonl.rst | 3 -- docs/nspr/reference/pr_htons.rst | 3 -- docs/nspr/reference/pr_implement.rst | 2 -- docs/nspr/reference/pr_implodetime.rst | 4 --- .../reference/pr_importfilemapfromstring.rst | 4 --- docs/nspr/reference/pr_importtcpsocket.rst | 6 ---- docs/nspr/reference/pr_init.rst | 3 -- docs/nspr/reference/pr_init_clist.rst | 3 -- docs/nspr/reference/pr_init_static_clist.rst | 3 -- docs/nspr/reference/pr_initialize.rst | 4 --- docs/nspr/reference/pr_initialized.rst | 2 -- docs/nspr/reference/pr_initializenetaddr.rst | 4 --- docs/nspr/reference/pr_insert_after.rst | 3 -- docs/nspr/reference/pr_insert_before.rst | 3 -- docs/nspr/reference/pr_insert_link.rst | 3 -- docs/nspr/reference/pr_interrupt.rst | 6 ---- docs/nspr/reference/pr_intervalnow.rst | 5 +-- .../reference/pr_intervaltomicroseconds.rst | 4 --- .../reference/pr_intervaltomilliseconds.rst | 4 --- docs/nspr/reference/pr_intervaltoseconds.rst | 4 --- docs/nspr/reference/pr_joinjob.rst | 3 -- docs/nspr/reference/pr_jointhread.rst | 8 ++--- docs/nspr/reference/pr_jointhreadpool.rst | 3 -- docs/nspr/reference/pr_list_head.rst | 4 --- docs/nspr/reference/pr_list_tail.rst | 4 --- docs/nspr/reference/pr_listen.rst | 4 --- docs/nspr/reference/pr_loadlibrary.rst | 4 --- .../nspr/reference/pr_localtimeparameters.rst | 4 --- docs/nspr/reference/pr_lock.rst | 4 --- docs/nspr/reference/pr_malloc.rst | 4 --- docs/nspr/reference/pr_memmap.rst | 4 --- .../reference/pr_microsecondstointerval.rst | 3 -- .../reference/pr_millisecondstointerval.rst | 3 -- docs/nspr/reference/pr_mkdir.rst | 5 --- docs/nspr/reference/pr_msec_per_sec.rst | 1 - docs/nspr/reference/pr_name.rst | 2 -- docs/nspr/reference/pr_netaddrtostring.rst | 4 --- docs/nspr/reference/pr_netdb_buf_size.rst | 1 - docs/nspr/reference/pr_new.rst | 4 --- docs/nspr/reference/pr_newcondvar.rst | 3 -- docs/nspr/reference/pr_newlock.rst | 3 -- docs/nspr/reference/pr_newmonitor.rst | 3 -- docs/nspr/reference/pr_newpollableevent.rst | 3 -- docs/nspr/reference/pr_newprocessattr.rst | 4 --- docs/nspr/reference/pr_newtcpsocket.rst | 4 --- .../reference/pr_newthreadprivateindex.rst | 4 --- docs/nspr/reference/pr_newudpsocket.rst | 4 --- docs/nspr/reference/pr_newzap.rst | 4 --- docs/nspr/reference/pr_next_link.rst | 4 --- docs/nspr/reference/pr_normalizetime.rst | 4 --- docs/nspr/reference/pr_notify.rst | 4 --- docs/nspr/reference/pr_notifyall.rst | 4 --- docs/nspr/reference/pr_notifyallcondvar.rst | 3 -- docs/nspr/reference/pr_notifycondvar.rst | 4 --- docs/nspr/reference/pr_now.rst | 4 --- docs/nspr/reference/pr_nsec_per_msec.rst | 1 - docs/nspr/reference/pr_nsec_per_sec.rst | 1 - docs/nspr/reference/pr_ntohl.rst | 3 -- docs/nspr/reference/pr_ntohs.rst | 3 -- docs/nspr/reference/pr_open.rst | 8 ++--- docs/nspr/reference/pr_openanonfilemap.rst | 4 --- docs/nspr/reference/pr_opendir.rst | 4 --- docs/nspr/reference/pr_opensemaphore.rst | 4 --- docs/nspr/reference/pr_opensharedmemory.rst | 4 --- docs/nspr/reference/pr_opentcpsocket.rst | 4 --- docs/nspr/reference/pr_openudpsocket.rst | 4 --- docs/nspr/reference/pr_poll.rst | 14 +++----- docs/nspr/reference/pr_popiolayer.rst | 4 --- docs/nspr/reference/pr_postsemaphore.rst | 3 -- docs/nspr/reference/pr_prev_link.rst | 4 --- .../pr_processattrsetinheritablefilemap.rst | 4 --- docs/nspr/reference/pr_processexit.rst | 2 -- docs/nspr/reference/pr_pushiolayer.rst | 6 ---- docs/nspr/reference/pr_queuejob.rst | 3 -- docs/nspr/reference/pr_queuejob_connect.rst | 3 -- docs/nspr/reference/pr_queuejob_read.rst | 3 -- docs/nspr/reference/pr_queuejob_timer.rst | 3 -- docs/nspr/reference/pr_queuejob_write.rst | 3 -- docs/nspr/reference/pr_queuejobaccept.rst | 3 -- docs/nspr/reference/pr_read.rst | 4 --- docs/nspr/reference/pr_readdir.rst | 5 --- docs/nspr/reference/pr_realloc.rst | 4 --- docs/nspr/reference/pr_recv.rst | 4 --- docs/nspr/reference/pr_recvfrom.rst | 4 --- .../reference/pr_remove_and_init_link.rst | 3 -- docs/nspr/reference/pr_remove_link.rst | 3 -- docs/nspr/reference/pr_rename.rst | 4 --- docs/nspr/reference/pr_rmdir.rst | 5 --- docs/nspr/reference/pr_secondstointerval.rst | 3 -- docs/nspr/reference/pr_seek.rst | 5 --- docs/nspr/reference/pr_seek64.rst | 5 --- docs/nspr/reference/pr_send.rst | 4 --- docs/nspr/reference/pr_sendto.rst | 4 --- docs/nspr/reference/pr_setconcurrency.rst | 3 -- docs/nspr/reference/pr_seterror.rst | 3 -- docs/nspr/reference/pr_seterrortext.rst | 3 -- docs/nspr/reference/pr_setlibrarypath.rst | 4 --- docs/nspr/reference/pr_setpollableevent.rst | 3 -- docs/nspr/reference/pr_setsocketoption.rst | 4 --- docs/nspr/reference/pr_setthreadpriority.rst | 3 -- docs/nspr/reference/pr_setthreadprivate.rst | 6 +--- docs/nspr/reference/pr_shutdown.rst | 4 --- docs/nspr/reference/pr_shutdownthreadpool.rst | 3 -- docs/nspr/reference/pr_sleep.rst | 4 --- docs/nspr/reference/pr_static_assert.rst | 4 --- docs/nspr/reference/pr_stringtonetaddr.rst | 4 --- docs/nspr/reference/pr_strtod.rst | 4 --- docs/nspr/reference/pr_sync.rst | 4 --- docs/nspr/reference/pr_tickspersecond.rst | 3 -- docs/nspr/reference/pr_transmitfile.rst | 4 --- .../reference/pr_unblockclockinterrupts.rst | 1 - docs/nspr/reference/pr_unloadlibrary.rst | 4 --- docs/nspr/reference/pr_unlock.rst | 4 --- docs/nspr/reference/pr_unmap.rst | 4 --- docs/nspr/reference/pr_usec_per_msec.rst | 1 - docs/nspr/reference/pr_usec_per_sec.rst | 1 - docs/nspr/reference/pr_version.rst | 2 -- docs/nspr/reference/pr_versioncheck.rst | 5 --- docs/nspr/reference/pr_wait.rst | 6 +--- docs/nspr/reference/pr_waitcondvar.rst | 4 --- .../reference/pr_waitforpollableevent.rst | 3 -- docs/nspr/reference/pr_waitsemaphore.rst | 4 --- docs/nspr/reference/pr_write.rst | 4 --- docs/nspr/reference/pr_writev.rst | 4 --- docs/nspr/reference/prbool.rst | 4 +-- docs/nspr/reference/prcalloncefn.rst | 2 -- docs/nspr/reference/prcalloncetype.rst | 3 -- docs/nspr/reference/prclist.rst | 2 -- docs/nspr/reference/prcondvar.rst | 2 -- docs/nspr/reference/prdescidentity.rst | 2 -- docs/nspr/reference/prdir.rst | 2 -- docs/nspr/reference/prerrorcode.rst | 2 -- docs/nspr/reference/prexplodedtime.rst | 4 +-- docs/nspr/reference/prfiledesc.rst | 3 -- docs/nspr/reference/prfileinfo.rst | 5 +-- docs/nspr/reference/prfileinfo64.rst | 3 -- docs/nspr/reference/prfilemap.rst | 2 -- docs/nspr/reference/prfileprivate.rst | 2 -- docs/nspr/reference/prfiletype.rst | 2 -- docs/nspr/reference/prfloat64.rst | 1 - docs/nspr/reference/prhostent.rst | 5 --- docs/nspr/reference/print16.rst | 1 - docs/nspr/reference/print32.rst | 2 -- docs/nspr/reference/print64.rst | 2 -- docs/nspr/reference/print8.rst | 1 - docs/nspr/reference/printervaltime.rst | 2 -- docs/nspr/reference/printn.rst | 1 - docs/nspr/reference/priomethods.rst | 3 -- docs/nspr/reference/pripv6addr.rst | 2 -- docs/nspr/reference/prjob.rst | 1 - docs/nspr/reference/prjobfn.rst | 1 - docs/nspr/reference/prjobiodesc.rst | 1 - docs/nspr/reference/prlibrary.rst | 2 -- docs/nspr/reference/prlinger.rst | 3 -- docs/nspr/reference/prlock.rst | 2 -- docs/nspr/reference/prlogmoduleinfo.rst | 9 +++--- docs/nspr/reference/prlogmodulelevel.rst | 17 +++++----- docs/nspr/reference/prmcastrequest.rst | 3 -- docs/nspr/reference/prmonitor.rst | 1 - docs/nspr/reference/prnetaddr.rst | 3 -- ...agement_and_interprocess_communication.rst | 18 +++++------ docs/nspr/reference/prpackedbool.rst | 2 -- docs/nspr/reference/prprimordialfn.rst | 2 -- docs/nspr/reference/prprocess.rst | 2 -- docs/nspr/reference/prprocessattr.rst | 2 -- docs/nspr/reference/prprotoent.rst | 2 -- docs/nspr/reference/prptrdiff.rst | 1 - docs/nspr/reference/prseekwhence.rst | 2 -- docs/nspr/reference/prsize.rst | 1 - docs/nspr/reference/prsocketoptiondata.rst | 3 -- docs/nspr/reference/prsockoption.rst | 3 -- docs/nspr/reference/prstaticlinktable.rst | 1 - docs/nspr/reference/prstatus.rst | 1 - docs/nspr/reference/prthread.rst | 2 -- docs/nspr/reference/prthreadpool.rst | 1 - docs/nspr/reference/prthreadpriority.rst | 4 --- docs/nspr/reference/prthreadprivatedtor.rst | 2 -- docs/nspr/reference/prthreadscope.rst | 3 -- docs/nspr/reference/prthreadstack.rst | 2 +- docs/nspr/reference/prthreadstate.rst | 3 -- docs/nspr/reference/prthreadtype.rst | 3 -- docs/nspr/reference/prtime.rst | 2 -- docs/nspr/reference/prtimeparameters.rst | 2 -- docs/nspr/reference/prtimeparamfn.rst | 2 -- docs/nspr/reference/pruint16.rst | 1 - docs/nspr/reference/pruint32.rst | 2 -- docs/nspr/reference/pruint64.rst | 2 -- docs/nspr/reference/pruint8.rst | 1 - docs/nspr/reference/pruintn.rst | 1 - docs/nspr/reference/prunichar.rst | 5 ++- docs/nspr/reference/pruptrdiff.rst | 1 - docs/nspr/reference/threads.rst | 4 +-- tools/lint/spell/exclude-list.txt | 1 + 335 files changed, 72 insertions(+), 1138 deletions(-) diff --git a/docs/nspr/about_nspr.rst b/docs/nspr/about_nspr.rst index 7aca156e5b6f..622bdeac521c 100644 --- a/docs/nspr/about_nspr.rst +++ b/docs/nspr/about_nspr.rst @@ -7,8 +7,6 @@ thread synchronization, normal file and network I/O, interval timing and calendar time, basic memory management (malloc and free) and shared library linking. -.. _History: - History ~~~~~~~ @@ -43,8 +41,6 @@ denominator*, but to exploit the best features of each operating system on which it runs, and still provide a uniform service across a wide range of host offerings. -.. _Threads: - Threads ^^^^^^^ @@ -100,8 +96,6 @@ IPv6. To that end it is possible to perform translations of ASCII strings (DNS names) into NSPR's network address structures, with no regard to whether the addressing technology is IPv4 or IPv6. -.. _Time: - Time ^^^^ @@ -141,8 +135,6 @@ functions. Depending on the platform, the functions may be implemented almost entirely in the NSPR runtime or simply shims that call immediately into the host operating system's offerings. -.. _Linking: - Linking ^^^^^^^ @@ -150,8 +142,6 @@ Support for linking (shared library loading and unloading) is part of NSPR's feature set. In most cases this is simply a smoothing over of the facilities offered by the various platform providers. -.. _Where_It.27s_Headed: - Where It's Headed ~~~~~~~~~~~~~~~~~ diff --git a/docs/nspr/creating_a_cookie_log.rst b/docs/nspr/creating_a_cookie_log.rst index d85ec4c591f8..06a0e905961e 100644 --- a/docs/nspr/creating_a_cookie_log.rst +++ b/docs/nspr/creating_a_cookie_log.rst @@ -11,8 +11,6 @@ below to run Firefox with cookie logging enabled. Enabling Cookie Logging ~~~~~~~~~~~~~~~~~~~~~~~ -.. _Windows: - Windows ^^^^^^^ @@ -25,8 +23,6 @@ normal installations of Windows). #. Type "set NSPR_LOG_MODULES=cookie:4" and press Enter #. Run Firefox by typing "firefox.exe" and pressing Enter. -.. _Linux: - Linux ^^^^^ @@ -39,8 +35,6 @@ already). #. Type "export NSPR_LOG_MODULES=cookie:4" and press Enter. #. Run Firefox by typing "./firefox" and pressing Enter -.. _Mac_OS_X: - Mac OS X ^^^^^^^^ @@ -57,8 +51,6 @@ modify these instructions already). #. Run Firefox by typing "./firefox-bin" and pressing Return (note that Firefox will launch behind windows for other applications). -.. _Creating_the_Log: - Creating the Log ~~~~~~~~~~~~~~~~ diff --git a/docs/nspr/index.rst b/docs/nspr/index.rst index 04f1f54eae16..b168ccc2dc02 100644 --- a/docs/nspr/index.rst +++ b/docs/nspr/index.rst @@ -6,8 +6,6 @@ system level and libc-like functions. The API is used in the Mozilla clients, many of Red Hat's and Oracle's server applications, and other software offerings. -.. _Documentation: - Documentation ------------- @@ -48,8 +46,6 @@ your platform: build symbols) for package *mozilla-nspr-32bit* - *mozilla-nspr-debugsource* : Debug sources for all of the above -.. _Community: - Community --------- diff --git a/docs/nspr/nonblocking_io_in_nspr.rst b/docs/nspr/nonblocking_io_in_nspr.rst index e5a6d8c2cae3..2875006fbdf2 100644 --- a/docs/nspr/nonblocking_io_in_nspr.rst +++ b/docs/nspr/nonblocking_io_in_nspr.rst @@ -129,8 +129,6 @@ native file descriptors (socket handles) cannot be added to PR_fd_set, i.e., the functions PR_FD_NSET, PR_FD_NCLR, PR_FD_NISSET do not work. -.. _PR_Available(): - PR_Available() -------------- diff --git a/docs/nspr/nspr_build_instructions.rst b/docs/nspr/nspr_build_instructions.rst index f4276e69df98..0e561622b556 100644 --- a/docs/nspr/nspr_build_instructions.rst +++ b/docs/nspr/nspr_build_instructions.rst @@ -9,8 +9,6 @@ utility suite such as MKS Toolkit, Cygwin, and MSYS. The easiest way to get these tools is to install the :ref:`MozillaBuild` package. -.. _Introduction: - Introduction ~~~~~~~~~~~~ @@ -66,8 +64,6 @@ Specify these two options to generate an optimized (release) build. These two options can actually be used independently, but it's not recommended. -.. _--enable-64bit: - --enable-64bit ^^^^^^^^^^^^^^ diff --git a/docs/nspr/nspr_contributor_guide.rst b/docs/nspr/nspr_contributor_guide.rst index ef58acf3a814..08a0ac2f991c 100644 --- a/docs/nspr/nspr_contributor_guide.rst +++ b/docs/nspr/nspr_contributor_guide.rst @@ -13,13 +13,9 @@ NSPR contributor guide should help the contributor in crafting his contribution, increasing its likelihood for acceptance. -.. _General_Guidelines: - General Guidelines ~~~~~~~~~~~~~~~~~~ -.. _Downward_Compatibility: - *Downward Compatibility* ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -30,16 +26,12 @@ NSPR cannot change. Should you need to have a similar API, with some slightly different behavior or different function prototype, then suggest a new API with a different name. -.. _C_Language_API: - *C Language API* ^^^^^^^^^^^^^^^^ The NSPR API is a C Language API. Please do not contribute Java, C or other language wrappers. -.. _Coding_Style: - *Coding Style* ^^^^^^^^^^^^^^ @@ -48,8 +40,6 @@ code. Make yours look like that. Some guidelines concerning naming conventions can be found in :ref:`NSPR_Naming_Conventions`. in the :ref:`NSPR API Reference`. -.. _Ownership_of_your_contribution: - *Ownership of your contribution* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -61,16 +51,12 @@ pay close attention to the rights of your "Day-Job" employer. If you snatched it from somewhere else, tell us where; show us where the right to incorporate it into NSPR exists. -.. _License_under_MPL_or_GPL: - *License under MPL or GPL* ^^^^^^^^^^^^^^^^^^^^^^^^^^ When you contribute material to NSPR, you agree to allow your contribution to be licensed under the MPL or GPL. -.. _BugFixes: - BugFixes ~~~~~~~~ @@ -82,8 +68,6 @@ Include your changes as diffs in an attachment to the BugZilla report. Use a coding style consistent with the source file you are changing. -.. _New_Features: - New Features ~~~~~~~~~~~~ @@ -123,7 +107,7 @@ See: `prshm.h `__ as an example of how your header file(s) should be documented. -**Source File Descriptions**. Provide descriptive documentation in your +*Source File Descriptions*o. Provide descriptive documentation in your source (*.c) files. Alas, we have no source files documented as we think they should be. @@ -135,15 +119,13 @@ features: - You must provide test cases that test all APIs you are adding. See: [#TestCases Test Cases] -.. _New_Libraries: - New Libraries ~~~~~~~~~~~~~ All the guidelines applicable to [#NewFeatures New Features] applies to new libraries. -For purposes of this paper, a "new library" is defined as a libary under +For purposes of this paper, a "new library" is defined as a library under the ``mozilla/nsprpub/lib`` directory tree and built as a separate library. These libraries exist, for the most part, as "legacy" code from NSPR 1.0. [Note that the current NSPR module owners do not now nor never @@ -157,8 +139,6 @@ applications using NSPR, such as ``...nsprpub/lib/libc/plgetopt.*.`` - May rely on the NSPR API - May NOT rely on any other library API -.. _New_Platform_Ports: - New Platform Ports ~~~~~~~~~~~~~~~~~~ @@ -167,8 +147,6 @@ New Platform Ports - platform specific code in ``pr/src/md/platform/*.c`` - make rules in ``config/_platform.mk`` -.. _Documentation: - Documentation ~~~~~~~~~~~~~ @@ -178,8 +156,6 @@ word processing system [don't ask]. Document your work as described in We will see that your documentation is transcribed into the appropriate word processor and the derived HTML shows up on mozilla.org -.. _Test_Cases: - Test Cases ~~~~~~~~~~ @@ -191,15 +167,13 @@ existing test case did not catch a bug it should have caught. The new test cases should be implemented in the style of other NSPR test cases. -Test cases should prove that the added API items work as advertized. +Test cases should prove that the added API items work as advertised. Test cases should serve as an example of how to use the API items. Test cases should provoke failure of every API item and report its failure. -.. _Frequently_Asked_Questions_(FAQ): - Frequently Asked Questions (FAQ) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/nspr/optimizing_applications_for_nspr.rst b/docs/nspr/optimizing_applications_for_nspr.rst index 11bdb85524f6..1bced161a82e 100644 --- a/docs/nspr/optimizing_applications_for_nspr.rst +++ b/docs/nspr/optimizing_applications_for_nspr.rst @@ -11,8 +11,6 @@ certainly surface. *This memo is by no way complete.* -.. _Multiplatform: - Multiplatform ------------- diff --git a/docs/nspr/reference/anonymous_shared_memory.rst b/docs/nspr/reference/anonymous_shared_memory.rst index 75d02b8d3b4f..f97ec979e25d 100644 --- a/docs/nspr/reference/anonymous_shared_memory.rst +++ b/docs/nspr/reference/anonymous_shared_memory.rst @@ -17,7 +17,7 @@ type. The anonymous file-mapped shared memory provides an inheritable shared memory, as in: the child process inherits the shared memory. Compare the file-mapped anonymous shared memory to to a named shared memory described in prshm.h. The intent is to provide a shared memory -that is accessbile only by parent and child processes. ... It's a +that is accessible only by parent and child processes. ... It's a security thing. Depending on the underlying platform, the file-mapped shared memory may diff --git a/docs/nspr/reference/cached_monitors.rst b/docs/nspr/reference/cached_monitors.rst index fdd3d3f290a7..647bdb1b5466 100644 --- a/docs/nspr/reference/cached_monitors.rst +++ b/docs/nspr/reference/cached_monitors.rst @@ -7,8 +7,6 @@ monitor for all objects. A hash table is used to quickly map addresses to their respective monitors. The system automatically enlarges the hash table as needed. -.. _Important: - Important --------- diff --git a/docs/nspr/reference/date_and_time.rst b/docs/nspr/reference/date_and_time.rst index 63b514999a1f..b86929b44ed5 100644 --- a/docs/nspr/reference/date_and_time.rst +++ b/docs/nspr/reference/date_and_time.rst @@ -72,8 +72,6 @@ functions of this type are provided by NSPR: - :ref:`PRTimeParamFn` - :ref:`PR_LocalTimeParameters` and :ref:`PR_GMTParameters` -.. _Functions: - Functions --------- diff --git a/docs/nspr/reference/dynamic_library_linking.rst b/docs/nspr/reference/dynamic_library_linking.rst index 3965ac94ad0b..cc8daf942458 100644 --- a/docs/nspr/reference/dynamic_library_linking.rst +++ b/docs/nspr/reference/dynamic_library_linking.rst @@ -1,6 +1,5 @@ - -Dynamic Library Search Path -=========================== +Dynamic Library Search +====================== This section describes NSPR's programming interface to load, unload and resolve symbols in dynamic libraries. It also provides a method by which @@ -75,10 +74,8 @@ for Win32. - `Exporting Symbols from the Main Executable Program <#Exporting_Symbols_from_the_Main_Executable_Program>`__ -.. _Dynamic_Library_Search_Path: - Dynamic Library Search Path -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ The dynamic library search path is the list of directories in which to look for a dynamic library. Each platform has its own standard diff --git a/docs/nspr/reference/floating_point_number_to_string_conversion.rst b/docs/nspr/reference/floating_point_number_to_string_conversion.rst index 4861d1ae6240..6c9b36003f0f 100644 --- a/docs/nspr/reference/floating_point_number_to_string_conversion.rst +++ b/docs/nspr/reference/floating_point_number_to_string_conversion.rst @@ -12,8 +12,6 @@ are: - :ref:`PR_dtoa` - :ref:`PR_cnvtf` -.. _References: - References ---------- diff --git a/docs/nspr/reference/i_o_functions.rst b/docs/nspr/reference/i_o_functions.rst index 184d3edcac6e..4ca887d1c60c 100644 --- a/docs/nspr/reference/i_o_functions.rst +++ b/docs/nspr/reference/i_o_functions.rst @@ -188,7 +188,7 @@ or unset. - :ref:`PR_WaitForPollableEvent` One can call :ref:`PR_Poll` with the :ref:`PR_POLL_READ` flag on a pollable -event. Whe the pollable event is set, :ref:`PR_Poll` returns the the +event. When the pollable event is set, :ref:`PR_Poll` returns the the :ref:`PR_POLL_READ` flag set in the out_flags. .. _Manipulating_Layers: diff --git a/docs/nspr/reference/index.rst b/docs/nspr/reference/index.rst index a5473e8394da..c5f549c9e380 100644 --- a/docs/nspr/reference/index.rst +++ b/docs/nspr/reference/index.rst @@ -22,8 +22,6 @@ NSPR API Reference - :ref:`NSPR_Sample_Code` -.. _NSPR_Types: - :ref:`NSPR_Types` ----------------- diff --git a/docs/nspr/reference/introduction_to_nspr.rst b/docs/nspr/reference/introduction_to_nspr.rst index e4037893b186..3c281d967535 100644 --- a/docs/nspr/reference/introduction_to_nspr.rst +++ b/docs/nspr/reference/introduction_to_nspr.rst @@ -155,15 +155,15 @@ scheduling algorithm to find the most appropriate thread. The chosen thread may be of higher priority, of the same priority, or even the same thread. It will not be a thread of lower priority. -Some operating systems cannot be made preemptable (for example, Mac OS +Some operating systems cannot be made preemptible (for example, Mac OS and Win 16). This puts them at some risk in supporting arbitrary code, even if the code is interpreted (Java). Other systems are not thread-aware, and their runtime libraries not thread-safe (most versions of Unix). These systems can support local level thread abstractions that -can be made preemptable, but run the risk of library corruption +can be made preemptible, but run the risk of library corruption (``libc``). Still other operating systems have a native notion of threads, and their libraries are thread-aware and support locking. -However, if local threads are also present, and they are preemptable, +However, if local threads are also present, and they are preemptible, they are subject to deadlock. At this time, the only safe solutions are to turn off preemption (a runtime decision) or to preempt global threads only. @@ -173,7 +173,7 @@ only. Interrupting Threads ^^^^^^^^^^^^^^^^^^^^ -NSPR threads are interruptable, with some constraints and +NSPR threads are interruptible, with some constraints and inconsistencies. To interrupt a thread, the caller of :ref:`PR_Interrupt` must have the NSPR diff --git a/docs/nspr/reference/logging.rst b/docs/nspr/reference/logging.rst index b263bd2a90c6..7846759c3186 100644 --- a/docs/nspr/reference/logging.rst +++ b/docs/nspr/reference/logging.rst @@ -105,10 +105,10 @@ debugging aids. myLM = PR_NewLogModule( "userStuff" ); PR_ASSERT( myLM ); - PR_LOG( myLM, PR_LOG_NOTICE, ("Log a Notice %d\n", 999 )); - for (i = 0; i < 10 ; i++ ) + PR_LOG( myLM, PR_LOG_NOTICE, ("Log a Notice %d\n", 999 )); + for (i = 0; i < 10 ; i++ ) { - PR_LOG( myLM, PR_LOG_DEBUG, ("Log Debug number: %d\n", i)); + PR_LOG( myLM, PR_LOG_DEBUG, ("Log Debug number: %d\n", i)); PR_Sleep( 500 ); } PR_LOG( myLM, PR_LOG_NOTICE, "That's all folks\n"); diff --git a/docs/nspr/reference/named_shared_memory.rst b/docs/nspr/reference/named_shared_memory.rst index 770f7826cbc3..dff1275cc40f 100644 --- a/docs/nspr/reference/named_shared_memory.rst +++ b/docs/nspr/reference/named_shared_memory.rst @@ -40,8 +40,6 @@ and cannot be reused. After you call :ref:`PR_DeleteSharedMemory`, any further use of the shared memory associated with the name may cause unpredictable results. -.. _Filenames: - Filenames ~~~~~~~~~ diff --git a/docs/nspr/reference/network_addresses.rst b/docs/nspr/reference/network_addresses.rst index d6f680cddb68..c6845e6efcde 100644 --- a/docs/nspr/reference/network_addresses.rst +++ b/docs/nspr/reference/network_addresses.rst @@ -53,7 +53,7 @@ Converting between a string and a network address - :ref:`PR_StringToNetAddr` - :ref:`PR_NetAddrToString` -.. _Getting_Host_Names_and_Addresses: +.. _Converting_address_formats: Converting address formats ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/nspr/reference/nspr_log_file.rst b/docs/nspr/reference/nspr_log_file.rst index f0b2370a40b8..1df56fcdee78 100644 --- a/docs/nspr/reference/nspr_log_file.rst +++ b/docs/nspr/reference/nspr_log_file.rst @@ -4,7 +4,6 @@ NSPR_LOG_FILE This environment variable specifies the file to which log messages are directed. -.. _Syntax: Syntax ------ @@ -13,16 +12,15 @@ Syntax filespec -*filespec* is a filename. The exact syntax is platform specific.  +*filespec* is a filename. The exact syntax is platform specific. -.. _Description: Description ----------- Use this environment variable to specify a log file other than the default. If :ref:`NSPR_LOG_FILE` is not in the environment, then log output -is written to ``stdout`` or ``stderr``, depending on the platform.  Set +is written to ``stdout`` or ``stderr``, depending on the platform. Set :ref:`NSPR_LOG_FILE` to the name of the log file you want to use. NSPR logging, when enabled, writes to the file named in this environment variable. diff --git a/docs/nspr/reference/nspr_log_modules.rst b/docs/nspr/reference/nspr_log_modules.rst index e8ddb69bbf91..98d783f7aa6c 100644 --- a/docs/nspr/reference/nspr_log_modules.rst +++ b/docs/nspr/reference/nspr_log_modules.rst @@ -4,7 +4,6 @@ NSPR_LOG_MODULES This environment variable specifies which log modules have logging enabled. -.. _Syntax: Syntax ------ @@ -27,7 +26,6 @@ following meanings: - 4 = PR_LOG_DEBUG: debug messages, notices - 5: everything! -.. _Description: Description ----------- @@ -36,12 +34,12 @@ Specify a ``moduleName`` that is associated with the ``name`` argument in a call to `:ref:`PR_NewLogModule` `__ and a non-zero ``level`` value to enable logging for the named -``moduleName``.  +``moduleName``. Special log module names are provided for controlling NSPR's log service at execution time. These controls should be set in the :ref:`NSPR_LOG_MODULES` environment variable at execution time to affect -NSPR's log service for your application.  +NSPR's log service for your application. - **all** The name ``all`` enables all log modules. To enable all log module calls to @@ -56,19 +54,17 @@ NSPR's log service for your application.  form "2015-01-15 21:24:26.049906 UTC - " prefixing every logged line. - **append** Including ``append`` results in log entries being appended - to the existing contents of the file referenced by NSPR_LOG_FILE.  If + to the existing contents of the file referenced by NSPR_LOG_FILE. If not specified, the existing contents of NSPR_LOG_FILE will be lost as a new file is created with the same filename. -- **sync** The name ``sync`` enables unbuffered logging.   This ensures +- **sync** The name ``sync`` enables unbuffered logging. This ensures that all log messages are flushed to the operating system as they are written, but may slow the program down. - **bufsize:size** The name ``bufsize:``\ *size* sets the log buffer to *size*. -.. _Examples: - Examples -------- diff --git a/docs/nspr/reference/pl_comparestrings.rst b/docs/nspr/reference/pl_comparestrings.rst index a1a2075d0e00..ba67e87d0033 100644 --- a/docs/nspr/reference/pl_comparestrings.rst +++ b/docs/nspr/reference/pl_comparestrings.rst @@ -3,7 +3,6 @@ PL_CompareStrings Compares two character strings. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax const void *v1, const void *v2); -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_comparevalues.rst b/docs/nspr/reference/pl_comparevalues.rst index 0c77bd8273d5..7ca379044a70 100644 --- a/docs/nspr/reference/pl_comparevalues.rst +++ b/docs/nspr/reference/pl_comparevalues.rst @@ -3,7 +3,6 @@ PL_CompareValues Compares two ``void *`` values numerically. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax void *v1, const void *v2); -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_hashstring.rst b/docs/nspr/reference/pl_hashstring.rst index 97a4f299a77c..bfcb60599c73 100644 --- a/docs/nspr/reference/pl_hashstring.rst +++ b/docs/nspr/reference/pl_hashstring.rst @@ -3,7 +3,6 @@ PL_HashString A general-purpose hash function for character strings. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PLHashNumber PL_HashString(const void *key); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,14 +22,12 @@ The function has the following parameter: ``key`` A pointer to a character string. -.. _Returns: Returns ~~~~~~~ The hash number for the specified key. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_hashtableadd.rst b/docs/nspr/reference/pl_hashtableadd.rst index c3429aacd17b..464c5faa14f1 100644 --- a/docs/nspr/reference/pl_hashtableadd.rst +++ b/docs/nspr/reference/pl_hashtableadd.rst @@ -3,7 +3,6 @@ PL_HashTableAdd Add a new entry with the specified key and value to the hash table. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax const void *key, void *value); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,14 +29,12 @@ The function has the following parameters: ``value`` A pointer to the value for the entry to be added. -.. _Returns: Returns ~~~~~~~ A pointer to the new entry. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_hashtabledestroy.rst b/docs/nspr/reference/pl_hashtabledestroy.rst index 9048614f4072..64bb097ad258 100644 --- a/docs/nspr/reference/pl_hashtabledestroy.rst +++ b/docs/nspr/reference/pl_hashtabledestroy.rst @@ -3,7 +3,6 @@ PL_HashTableDestroy Frees the table and all the entries. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PL_HashTableDestroy(PLHashTable *ht); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``ht`` A pointer to the hash table to be destroyed. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_hashtableenumerateentries.rst b/docs/nspr/reference/pl_hashtableenumerateentries.rst index 8ca29fde3caf..8933da88b693 100644 --- a/docs/nspr/reference/pl_hashtableenumerateentries.rst +++ b/docs/nspr/reference/pl_hashtableenumerateentries.rst @@ -4,7 +4,6 @@ PL_HashTableEnumerateEntries Enumerates all the entries in the hash table, invoking a specified function on each entry. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PLHashEnumerator f, void *arg); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -32,14 +30,12 @@ The function has the following parameters: ``arg`` Argument for function ``f``. -.. _Returns: Returns ~~~~~~~ The number of entries enumerated. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_hashtablelookup.rst b/docs/nspr/reference/pl_hashtablelookup.rst index 00d7921c2dec..11bb8b834804 100644 --- a/docs/nspr/reference/pl_hashtablelookup.rst +++ b/docs/nspr/reference/pl_hashtablelookup.rst @@ -3,7 +3,6 @@ PL_HashTableLookup Looks up the entry with the specified key and return its value. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PLHashTable *ht, const void *key); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -29,7 +27,6 @@ The function has the following parameters: ``key`` A pointer to the key for the entry to look up. -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ Returns The value of the entry with the specified key, or ``NULL`` if there is no such entry. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_hashtableremove.rst b/docs/nspr/reference/pl_hashtableremove.rst index 67bee6289aa0..29fbc63a9c46 100644 --- a/docs/nspr/reference/pl_hashtableremove.rst +++ b/docs/nspr/reference/pl_hashtableremove.rst @@ -3,7 +3,6 @@ PL_HashTableRemove Removes the entry with the specified key from the hash table. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PLHashTable *ht, const void *key); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has the following parameters: ``key`` A pointer to the key for the entry to be removed. -.. _Description: Description ----------- @@ -42,7 +39,6 @@ returns ``PR_TRUE``. If the table is underloaded, :ref:`PL_HashTableRemove` also shrinks the number of buckets by half. -.. _Remark: Remark ------ diff --git a/docs/nspr/reference/pl_newhashtable.rst b/docs/nspr/reference/pl_newhashtable.rst index 82d3b4aab99d..ea6dbaee5968 100644 --- a/docs/nspr/reference/pl_newhashtable.rst +++ b/docs/nspr/reference/pl_newhashtable.rst @@ -3,7 +3,6 @@ PL_NewHashTable Create a new hash table. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax void *allocPriv ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -42,14 +40,12 @@ The function has the following parameters: ``allocPriv`` Passed as the first argument (pool). -.. _Returns: Returns ~~~~~~~ The new hash table. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pl_strcpy.rst b/docs/nspr/reference/pl_strcpy.rst index 2d7ae2c0ed9c..4b230f23ef8c 100644 --- a/docs/nspr/reference/pl_strcpy.rst +++ b/docs/nspr/reference/pl_strcpy.rst @@ -5,7 +5,6 @@ PL_strcpy Copies a string, up to and including the trailing ``'\0'``, into a destination buffer. -.. _Syntax: Syntax ~~~~~~ @@ -14,7 +13,6 @@ Syntax char * PL_strcpy(char *dest, const char *src); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -27,7 +25,6 @@ The function has these parameters: ``src`` Pointer to the string to be copied. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ Returns The function returns a pointer to the buffer specified by the ``dest`` parameter. -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/pl_strdup.rst b/docs/nspr/reference/pl_strdup.rst index 5d65a1c4e56f..22a9f2f22168 100644 --- a/docs/nspr/reference/pl_strdup.rst +++ b/docs/nspr/reference/pl_strdup.rst @@ -4,7 +4,6 @@ PL_strdup Returns a pointer to a new memory node in the NSPR heap containing a copy of a specified string. -.. _Syntax: Syntax ~~~~~~ @@ -15,7 +14,6 @@ Syntax char *PL_strdup(const char *s); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has a single parameter: ``s`` The string to copy, may be ``NULL``. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ The function returns one of these values: - If successful, a pointer to a copy of the specified string. - If the memory allocation fails, ``NULL``. -.. _Description: Description ~~~~~~~~~~~ @@ -45,8 +41,6 @@ greater than the length of the string being copied. A ``NULL`` argument, like a zero-length argument, results in a pointer to a one-byte block of memory containing the null value. -.. _Notes: - Notes ~~~~~ diff --git a/docs/nspr/reference/pl_strfree.rst b/docs/nspr/reference/pl_strfree.rst index 7e68ad165352..5276b8c5b41d 100644 --- a/docs/nspr/reference/pl_strfree.rst +++ b/docs/nspr/reference/pl_strfree.rst @@ -3,7 +3,6 @@ PL_strfree Frees memory allocated by :ref:`PL_strdup` -.. _Syntax: Syntax ~~~~~~ @@ -12,7 +11,6 @@ Syntax void PL_strfree(char *s); -.. _Parameter: Parameter ~~~~~~~~~ diff --git a/docs/nspr/reference/pl_strlen.rst b/docs/nspr/reference/pl_strlen.rst index 8521702fabec..e85fbb0f16df 100644 --- a/docs/nspr/reference/pl_strlen.rst +++ b/docs/nspr/reference/pl_strlen.rst @@ -4,7 +4,6 @@ PL_strlen Returns the length of a specified string (not including the trailing ``'\0'``) -.. _Syntax: Syntax ~~~~~~ @@ -13,7 +12,6 @@ Syntax PRUint32 PL_strlen(const char *str); -.. _Parameter: Parameter ~~~~~~~~~ @@ -23,7 +21,6 @@ The function has these parameter: ``str`` Size in bytes of item to be allocated. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/plhashallocops.rst b/docs/nspr/reference/plhashallocops.rst index c6ce0d26640c..2392e3ad6cae 100644 --- a/docs/nspr/reference/plhashallocops.rst +++ b/docs/nspr/reference/plhashallocops.rst @@ -1,4 +1,3 @@ -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax #define HT_FREE_VALUE 0 /* just free the entry's value */ #define HT_FREE_ENTRY 1 /* free value and entire entry */ -.. _Description: Description ----------- @@ -34,7 +32,6 @@ to a memory pool used by the memory allocator. The ``freeEntry`` function does not need to free the value of the entry. If flag is ``HT_FREE_ENTRY``, the function frees the entry. -.. _Remark: Remark ------ diff --git a/docs/nspr/reference/plhashcomparator.rst b/docs/nspr/reference/plhashcomparator.rst index 4d36d20ee12e..93b817b036ff 100644 --- a/docs/nspr/reference/plhashcomparator.rst +++ b/docs/nspr/reference/plhashcomparator.rst @@ -1,7 +1,6 @@ PLHashComparator ================ -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax const void *v1, const void *v2); -.. _Description: Description ----------- @@ -29,7 +27,6 @@ For convenience, two comparator functions are provided. :ref:`PL_CompareValues` compares the values of the arguments v1 and v2 numerically. -.. _Remark: Remark ------ @@ -37,7 +34,6 @@ Remark The return value of :ref:`PLHashComparator` functions should be of type :ref:`PRBool`. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/plhashentry.rst b/docs/nspr/reference/plhashentry.rst index 53e83e867034..c74a8006d6cd 100644 --- a/docs/nspr/reference/plhashentry.rst +++ b/docs/nspr/reference/plhashentry.rst @@ -1,4 +1,3 @@ -.. _Syntax: Syntax ------ @@ -9,7 +8,6 @@ Syntax typedef struct PLHashEntry PLHashEntry; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/plhashenumerator.rst b/docs/nspr/reference/plhashenumerator.rst index a4bd72eda999..bf1ecddc8304 100644 --- a/docs/nspr/reference/plhashenumerator.rst +++ b/docs/nspr/reference/plhashenumerator.rst @@ -1,4 +1,3 @@ -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax #define HT_ENUMERATE_REMOVE 2 /* remove and free the current entry */ #define HT_ENUMERATE_UNHASH 4 /* just unhash the current entry */ -.. _Description: Description ----------- @@ -26,7 +24,6 @@ to a user-specified function of type ``PLHashEnumerator`` with the hash table entry, an integer index, and an arbitrary piece of user data as argument. -.. _Remark: Remark ------ @@ -37,7 +34,6 @@ The entries are unlinked from the table, they are not freed, but the entry count (the ``nentries`` field of the ``PLHashTable`` structure) is not decremented. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/plhashfunction.rst b/docs/nspr/reference/plhashfunction.rst index 28fd822a7941..631fc4113f19 100644 --- a/docs/nspr/reference/plhashfunction.rst +++ b/docs/nspr/reference/plhashfunction.rst @@ -1,4 +1,3 @@ -.. _Syntax: Syntax ------ @@ -9,7 +8,6 @@ Syntax typedef PLHashNumber (PR_CALLBACK *PLHashFunction)(const void *key); -.. _Description: Description ----------- @@ -17,7 +15,6 @@ Description ``PLHashNumber`` is a function type that maps the key of a hash table entry to a hash number. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/plhashnumber.rst b/docs/nspr/reference/plhashnumber.rst index 959224279a13..e26afae63593 100644 --- a/docs/nspr/reference/plhashnumber.rst +++ b/docs/nspr/reference/plhashnumber.rst @@ -1,4 +1,3 @@ -.. _Syntax: Syntax ------ @@ -11,7 +10,6 @@ Syntax #define PL_HASH_BITS 32 -.. _Description: Description ----------- @@ -24,7 +22,6 @@ bucket. The macro ``PL_HASH_BITS`` is the size (in bits) of the ``PLHashNumber`` data type and has the value of 32. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/plhashtable.rst b/docs/nspr/reference/plhashtable.rst index 2d67e186026b..1802ae03ce16 100644 --- a/docs/nspr/reference/plhashtable.rst +++ b/docs/nspr/reference/plhashtable.rst @@ -1,4 +1,3 @@ -.. _Syntax: Syntax ------ @@ -9,7 +8,6 @@ Syntax typedef struct PLHashTable PLHashTable; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_abort.rst b/docs/nspr/reference/pr_abort.rst index d844179384f5..4073edd4cb1a 100644 --- a/docs/nspr/reference/pr_abort.rst +++ b/docs/nspr/reference/pr_abort.rst @@ -3,7 +3,6 @@ PR_Abort Aborts the process in a nongraceful manner. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_Abort(void); -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_accept.rst b/docs/nspr/reference/pr_accept.rst index 06d7a117875c..b5273efdfee1 100644 --- a/docs/nspr/reference/pr_accept.rst +++ b/docs/nspr/reference/pr_accept.rst @@ -3,7 +3,6 @@ PR_Accept Accepts a connection on a specified socket. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRNetAddr *addr, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -34,7 +32,6 @@ The function has the following parameters: A value of type :ref:`PRIntervalTime` specifying the time limit for completion of the accept operation. -.. _Returns: Returns ~~~~~~~ @@ -46,7 +43,6 @@ The function returns one of the following values: - If unsuccessful, ``NULL``. Further information can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_acceptread.rst b/docs/nspr/reference/pr_acceptread.rst index fbc814cc8d48..8015fbe6a633 100644 --- a/docs/nspr/reference/pr_acceptread.rst +++ b/docs/nspr/reference/pr_acceptread.rst @@ -3,7 +3,6 @@ PR_AcceptRead Accepts a new connection and receives a block of data. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax PRInt32 amount, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -57,7 +55,6 @@ The function has the following parameters: is accepted; the read will time out after the timeout interval elapses. -.. _Returns: Returns ~~~~~~~ @@ -66,7 +63,6 @@ Returns - The value -1 indicates a failure. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_access.rst b/docs/nspr/reference/pr_access.rst index 6db72607ed42..c36986bfde96 100644 --- a/docs/nspr/reference/pr_access.rst +++ b/docs/nspr/reference/pr_access.rst @@ -3,7 +3,6 @@ PR_Access Determines the accessibility of a file. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax const char *name, PRAccessHow how); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -33,7 +31,6 @@ The function has the following parameters: - :ref:`PR_ACCESS_WRITE_OK`. Test for write permission. - :ref:`PR_ACCESS_EXISTS`. Check existence of file. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_append_link.rst b/docs/nspr/reference/pr_append_link.rst index 2602cb3b0afa..1fca7510d580 100644 --- a/docs/nspr/reference/pr_append_link.rst +++ b/docs/nspr/reference/pr_append_link.rst @@ -3,7 +3,6 @@ PR_APPEND_LINK Appends an element to the end of a list. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRCList *elemp, PRCList *listp); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ Parameters ``listp`` A pointer to the list. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_assert.rst b/docs/nspr/reference/pr_assert.rst index c92bcf7cc378..b9b7de7d3412 100644 --- a/docs/nspr/reference/pr_assert.rst +++ b/docs/nspr/reference/pr_assert.rst @@ -3,7 +3,6 @@ PR_ASSERT Terminates execution when a given expression is ``FALSE``. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_ASSERT ( expression ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -25,14 +23,12 @@ expression Any valid C language expression that evaluates to ``TRUE`` or ``FALSE``. -.. _Returns: Returns ~~~~~~~ Nothing -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_atomicadd.rst b/docs/nspr/reference/pr_atomicadd.rst index 057a160108d2..7314dfb17c70 100644 --- a/docs/nspr/reference/pr_atomicadd.rst +++ b/docs/nspr/reference/pr_atomicadd.rst @@ -1,7 +1,6 @@ PR_AtomicAdd ============ -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRInt32 *ptr, PRInt32 val); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,18 +24,16 @@ The function has the following parameters: ``val`` A value to be added. -.. _Returns: Returns ~~~~~~~ The returned value is the result of the addition. -.. _Description: Description ----------- Atomically add a 32 bit value. -  + diff --git a/docs/nspr/reference/pr_atomicdecrement.rst b/docs/nspr/reference/pr_atomicdecrement.rst index 45c18f4b3945..c23b90ba21c6 100644 --- a/docs/nspr/reference/pr_atomicdecrement.rst +++ b/docs/nspr/reference/pr_atomicdecrement.rst @@ -3,7 +3,6 @@ PR_AtomicDecrement Atomically decrements a 32-bit value. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRInt32 PR_AtomicDecrement(PRInt32 *val); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,14 +22,12 @@ The function has the following parameter: ``val`` A pointer to the value to decrement. -.. _Returns: Returns ~~~~~~~ The function returns the decremented value (i.e., the result). -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_atomicincrement.rst b/docs/nspr/reference/pr_atomicincrement.rst index 0b960beb0c65..775c300ceb9d 100644 --- a/docs/nspr/reference/pr_atomicincrement.rst +++ b/docs/nspr/reference/pr_atomicincrement.rst @@ -3,7 +3,6 @@ PR_AtomicIncrement Atomically increments a 32-bit value. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRInt32 PR_AtomicIncrement(PRInt32 *val); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,14 +22,12 @@ The function has the following parameter: ``val`` A pointer to the value to increment. -.. _Returns: Returns ~~~~~~~ The function returns the incremented value (i.e., the result). -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_atomicset.rst b/docs/nspr/reference/pr_atomicset.rst index 8be60be71548..46ec08b939de 100644 --- a/docs/nspr/reference/pr_atomicset.rst +++ b/docs/nspr/reference/pr_atomicset.rst @@ -3,7 +3,6 @@ PR_AtomicSet Atomically sets a 32-bit value and return its previous contents. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRInt32 *val, PRInt32 newval); -.. _Parameter: Parameters ~~~~~~~~~~ @@ -28,14 +26,12 @@ The function has the following parameter: ``newval`` The new value to assign to the ``val`` parameter. -.. _Returns: Returns ~~~~~~~ The function returns the prior value of the referenced variable. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_attachsharedmemory.rst b/docs/nspr/reference/pr_attachsharedmemory.rst index 32ef3022c19c..f929d5cc7b93 100644 --- a/docs/nspr/reference/pr_attachsharedmemory.rst +++ b/docs/nspr/reference/pr_attachsharedmemory.rst @@ -4,7 +4,6 @@ PR_AttachSharedMemory Attaches a memory segment previously opened with :ref:`PR_OpenSharedMemory` and maps it into the process memory space. -.. _Syntax: Syntax ------ @@ -24,7 +23,6 @@ Syntax /* Define values for PR_AttachSharedMemory(...,flags) */ #define PR_SHM_READONLY 0x01 -.. _Parameters: Parameters ~~~~~~~~~~ @@ -37,7 +35,6 @@ flags Options for mapping the shared memory. ``PR_SHM_READONLY`` causes the memory to be attached read-only. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_attachthread.rst b/docs/nspr/reference/pr_attachthread.rst index b9aa5b3e663a..4ec1eb958ab3 100644 --- a/docs/nspr/reference/pr_attachthread.rst +++ b/docs/nspr/reference/pr_attachthread.rst @@ -10,7 +10,6 @@ PR_AttachThread Associates a :ref:`PRThread` object with an existing native thread. -.. _Syntax: Syntax ------ @@ -24,7 +23,6 @@ Syntax PRThreadPriority priority, PRThreadStack *stack); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -39,7 +37,6 @@ Parameters ``stack`` The stack for the thread being attached. -.. _Returns: Returns ~~~~~~~ @@ -50,7 +47,6 @@ The function returns one of these values: - If unsuccessful, for example if system resources are not available, ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_available.rst b/docs/nspr/reference/pr_available.rst index 5d9a1f6ce9ac..926a6e9dbc5a 100644 --- a/docs/nspr/reference/pr_available.rst +++ b/docs/nspr/reference/pr_available.rst @@ -5,7 +5,6 @@ Determines the number of bytes (expressed as a 32-bit integer) that are available for reading beyond the current read-write pointer in a specified file or socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRInt32 PR_Available(PRFileDesc *fd); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameter: ``fd`` Pointer to a :ref:`PRFileDesc` object representing a file or socket. -.. _Returns: Returns ~~~~~~~ @@ -39,7 +36,6 @@ The function returns one of the following values: - If the function fails, it returns the value -1. The error code can then be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -47,7 +43,6 @@ Description :ref:`PR_Available` works on normal files and sockets. :ref:`PR_Available` does not work with pipes on Win32 platforms. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_available64.rst b/docs/nspr/reference/pr_available64.rst index 290796e86af4..da4b4e68e640 100644 --- a/docs/nspr/reference/pr_available64.rst +++ b/docs/nspr/reference/pr_available64.rst @@ -5,7 +5,6 @@ Determines the number of bytes (expressed as a 32-bit integer) that are available for reading beyond the current read-write pointer in a specified file or socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRInt64 PR_Available64(PRFileDesc *fd); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameter: ``fd`` Pointer to a :ref:`PRFileDesc` object representing a file or socket. -.. _Returns: Returns ~~~~~~~ @@ -39,7 +36,6 @@ The function returns one of the following values: - If the function fails, it returns the value -1. The error code can then be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -47,7 +43,6 @@ Description :ref:`PR_Available64` works on normal files and sockets. :ref:`PR_Available` does not work with pipes on Win32 platforms. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_bind.rst b/docs/nspr/reference/pr_bind.rst index e481bd11d607..69da8822fba2 100644 --- a/docs/nspr/reference/pr_bind.rst +++ b/docs/nspr/reference/pr_bind.rst @@ -3,7 +3,6 @@ PR_Bind Binds an address to a specified socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *fd, const PRNetAddr *addr); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -29,7 +27,6 @@ The function has the following parameters: A pointer to a :ref:`PRNetAddr` object representing the address to which the socket will be bound. -.. _Returns: Returns ~~~~~~~ @@ -40,7 +37,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. Further information can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_blockclockinterrupts.rst b/docs/nspr/reference/pr_blockclockinterrupts.rst index d0b8afd78f7f..a4eb47a08037 100644 --- a/docs/nspr/reference/pr_blockclockinterrupts.rst +++ b/docs/nspr/reference/pr_blockclockinterrupts.rst @@ -3,7 +3,6 @@ PR_BlockClockInterrupts Blocks the timer signal used for preemptive scheduling. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_callback.rst b/docs/nspr/reference/pr_callback.rst index 26afda89fd0f..931926ab08bc 100644 --- a/docs/nspr/reference/pr_callback.rst +++ b/docs/nspr/reference/pr_callback.rst @@ -4,7 +4,6 @@ PR_CALLBACKimplementation Used to define pointers to functions that will be implemented by the client but called from a (different) shared library. -.. _Syntax: Syntax ------ @@ -13,7 +12,6 @@ Syntax #include type PR_CALLBACKimplementation -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_calloc.rst b/docs/nspr/reference/pr_calloc.rst index 80bd1edee261..26e9b7f9a2bb 100644 --- a/docs/nspr/reference/pr_calloc.rst +++ b/docs/nspr/reference/pr_calloc.rst @@ -4,7 +4,6 @@ PR_Calloc Allocates zeroed memory from the heap for a number of objects of a given size. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRUint32 nelem, PRUint32 elsize); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -27,7 +25,6 @@ Parameters ``elsize`` The size of an individual element. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ An untyped pointer to the allocated memory, or if the allocation attempt fails, ``NULL``. Call ``PR_GetError()`` to retrieve the error returned by the libc function ``malloc()``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_callonce.rst b/docs/nspr/reference/pr_callonce.rst index e8452d8128af..b3c44f8edbdc 100644 --- a/docs/nspr/reference/pr_callonce.rst +++ b/docs/nspr/reference/pr_callonce.rst @@ -3,7 +3,6 @@ PR_CallOnce Ensures that subsystem initialization occurs only once. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRCallOnceType *once, PRCallOnceFN func); -.. _Parameters: Parameters ~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_canceljob.rst b/docs/nspr/reference/pr_canceljob.rst index ed141b3820f2..74e0aaa3f527 100644 --- a/docs/nspr/reference/pr_canceljob.rst +++ b/docs/nspr/reference/pr_canceljob.rst @@ -3,7 +3,6 @@ PR_CancelJob Causes a previously queued job to be canceled. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax NSPR_API(PRStatus) PR_CancelJob(PRJob *job); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: A pointer to a :ref:`PRJob` structure returned by a :ref:`PR_QueueJob` function representing the job to be cancelled. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_centermonitor.rst b/docs/nspr/reference/pr_centermonitor.rst index ef71c2105d6f..bb83493e5140 100644 --- a/docs/nspr/reference/pr_centermonitor.rst +++ b/docs/nspr/reference/pr_centermonitor.rst @@ -3,7 +3,6 @@ PR_CEnterMonitor Enters the lock associated with a cached monitor. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRMonitor* PR_CEnterMonitor(void *address); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameter: reference must remain valid as long as there are monitoring operations being performed. -.. _Returns: Returns ~~~~~~~ @@ -38,7 +35,6 @@ The function returns one of the following values: - If unsuccessful (the monitor cache needs to be expanded and the system is out of memory), the function returns ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_cexitmonitor.rst b/docs/nspr/reference/pr_cexitmonitor.rst index 53833186599f..6350ccb77ad0 100644 --- a/docs/nspr/reference/pr_cexitmonitor.rst +++ b/docs/nspr/reference/pr_cexitmonitor.rst @@ -3,7 +3,6 @@ PR_CExitMonitor Decrement the entry count associated with a cached monitor. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_CExitMonitor(void *address); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameters: The address of the protected object--the same address previously passed to :ref:`PR_CEnterMonitor`. -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ The function returns one of the following values: parameter is invalid or that the calling thread is not in the monitor. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_cleanup.rst b/docs/nspr/reference/pr_cleanup.rst index 5f291f4f6e4e..d685ee494688 100644 --- a/docs/nspr/reference/pr_cleanup.rst +++ b/docs/nspr/reference/pr_cleanup.rst @@ -3,7 +3,6 @@ PR_Cleanup Coordinates a graceful shutdown of NSPR. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_Cleanup(void); -.. _Returns: Returns ~~~~~~~ @@ -25,7 +23,6 @@ The function returns one of the following values: - If the calling thread of this function is not the primordial thread, ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_clearinterrupt.rst b/docs/nspr/reference/pr_clearinterrupt.rst index b5fa989f6959..e5e88cfa018f 100644 --- a/docs/nspr/reference/pr_clearinterrupt.rst +++ b/docs/nspr/reference/pr_clearinterrupt.rst @@ -3,7 +3,6 @@ PR_ClearInterrupt Clears the interrupt request for the calling thread. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_ClearInterrupt(void); -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_clist_is_empty.rst b/docs/nspr/reference/pr_clist_is_empty.rst index 1a3a945a4b49..685b8f8ba969 100644 --- a/docs/nspr/reference/pr_clist_is_empty.rst +++ b/docs/nspr/reference/pr_clist_is_empty.rst @@ -3,7 +3,6 @@ PR_CLIST_IS_EMPTY Checks for an empty circular list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRIntn PR_CLIST_IS_EMPTY (PRCList *listp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``listp`` A pointer to the linked list. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_close.rst b/docs/nspr/reference/pr_close.rst index ebf4e074d5a9..2e67b0f1f97c 100644 --- a/docs/nspr/reference/pr_close.rst +++ b/docs/nspr/reference/pr_close.rst @@ -3,7 +3,6 @@ PR_Close Closes a file descriptor. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_Close(PRFileDesc *fd); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameters: ``fd`` A pointer to a :ref:`PRFileDesc` object. -.. _Returns: Returns ~~~~~~~ @@ -34,7 +31,6 @@ One of the following values: - If file descriptor is closed successfully, ``PR_SUCCESS``. - If the file descriptor is not closed successfully, ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_closedir.rst b/docs/nspr/reference/pr_closedir.rst index 92bb2f96b402..f5a5af6a6a73 100644 --- a/docs/nspr/reference/pr_closedir.rst +++ b/docs/nspr/reference/pr_closedir.rst @@ -3,7 +3,6 @@ PR_CloseDir Closes the specified directory. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_CloseDir(PRDir *dir); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: A pointer to a :ref:`PRDir` structure representing the directory to be closed. -.. _Returns: Returns ~~~~~~~ @@ -34,7 +31,6 @@ Returns - If unsuccessful, ``PR_FAILURE``. The reason for the failure can be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -44,7 +40,6 @@ with a call to :ref:`PR_CloseDir` call. Note that after a :ref:`PR_CloseDir` call, any ``PRDirEntry`` object returned by a previous :ref:`PR_ReadDir` call on the same :ref:`PRDir` object becomes invalid. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_closefilemap.rst b/docs/nspr/reference/pr_closefilemap.rst index eadd207b5f08..9aab71a776e5 100644 --- a/docs/nspr/reference/pr_closefilemap.rst +++ b/docs/nspr/reference/pr_closefilemap.rst @@ -3,7 +3,6 @@ PR_CloseFileMap Closes a file mapping. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_CloseFileMap(PRFileMap *fmap); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``fmap`` The file mapping to be closed. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ The function returns one of the following values: - If the memory region is not successfully unmapped, ``PR_FAILURE``. The error code can be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_closesemaphore.rst b/docs/nspr/reference/pr_closesemaphore.rst index 4d0488002cec..8bf05f260864 100644 --- a/docs/nspr/reference/pr_closesemaphore.rst +++ b/docs/nspr/reference/pr_closesemaphore.rst @@ -3,7 +3,6 @@ PR_CloseSemaphore Closes a specified semaphore. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax NSPR_API(PRStatus) PR_CloseSemaphore(PRSem *sem); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: A pointer to a ``PRSem`` structure returned from a call to :ref:`PR_OpenSemaphore`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_closesharedmemory.rst b/docs/nspr/reference/pr_closesharedmemory.rst index 1af109966ad7..9ad255157638 100644 --- a/docs/nspr/reference/pr_closesharedmemory.rst +++ b/docs/nspr/reference/pr_closesharedmemory.rst @@ -3,7 +3,6 @@ PR_CloseSharedMemory Closes a shared memory segment identified by name. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRSharedMemory *shm ); -.. _Parameter: Parameter ~~~~~~~~~ @@ -27,7 +25,6 @@ The function has these parameter: shm The handle returned from :ref:`PR_OpenSharedMemory`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_cnotify.rst b/docs/nspr/reference/pr_cnotify.rst index 0bedd1072f8c..d0fda750d211 100644 --- a/docs/nspr/reference/pr_cnotify.rst +++ b/docs/nspr/reference/pr_cnotify.rst @@ -3,7 +3,6 @@ PR_CNotify Notify a thread waiting on a change in the state of monitored data. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_CNotify(void *address); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: The address of the monitored object. The calling thread must be in the monitor defined by the value of the address. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ Returns - :ref:`PR_FAILURE` indicates that the monitor has not been entered by the calling thread. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_cnotifyall.rst b/docs/nspr/reference/pr_cnotifyall.rst index 1d166a94872c..4acfc52b6a96 100644 --- a/docs/nspr/reference/pr_cnotifyall.rst +++ b/docs/nspr/reference/pr_cnotifyall.rst @@ -4,7 +4,6 @@ PR_CNotifyAll Notifies all the threads waiting for a change in the state of monitored data. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRStatus PR_CNotifyAll(void *address); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameter: The address of the monitored object. The calling thread must be in the monitor at the time :ref:`PR_CNotifyAll` is called. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ Returns - :ref:`PR_FAILURE` indicates that the referenced monitor could not be located or that the calling thread was not in the monitor -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_cnvtf.rst b/docs/nspr/reference/pr_cnvtf.rst index 09bf8c537fb8..de90b72a6a38 100644 --- a/docs/nspr/reference/pr_cnvtf.rst +++ b/docs/nspr/reference/pr_cnvtf.rst @@ -3,7 +3,6 @@ PR_cnvtf Converts a floating point number to a string. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRIntn prcsn, PRFloat64 fval); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -35,7 +33,6 @@ The function has these parameters: ``fval`` The double-precision floating point number to be converted. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_connect.rst b/docs/nspr/reference/pr_connect.rst index 633011d63392..1810cff72a81 100644 --- a/docs/nspr/reference/pr_connect.rst +++ b/docs/nspr/reference/pr_connect.rst @@ -3,7 +3,6 @@ PR_Connect Initiates a connection on a specified socket. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax const PRNetAddr *addr, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -33,7 +31,6 @@ The function has the following parameters: A value of type :ref:`PRIntervalTime` specifying the time limit for completion of the connect operation. -.. _Returns: Returns ~~~~~~~ @@ -44,7 +41,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. Further information can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_connectcontinue.rst b/docs/nspr/reference/pr_connectcontinue.rst index 9a8bc012186c..cc0ddc0ca5c8 100644 --- a/docs/nspr/reference/pr_connectcontinue.rst +++ b/docs/nspr/reference/pr_connectcontinue.rst @@ -1,7 +1,6 @@ PR_ConnectContinue ================== -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRFileDesc *fd, PRInt16 out_flags); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has the following parameters: The out_flags field of the poll descriptor returned by `PR_Poll() `__. -.. _Returns: Returns ~~~~~~~ @@ -36,14 +33,13 @@ Returns - If the nonblocking connect has successfully completed, PR_ConnectContinue returns PR_SUCCESS. - If PR_ConnectContinue() returns PR_FAILURE, call PR_GetError(): -      - PR_IN_PROGRESS_ERROR: the nonblocking connect is still in +- PR_IN_PROGRESS_ERROR: the nonblocking connect is still in progress and has not completed yet. The caller should poll the file descriptor for the in_flags PR_POLL_WRITE|PR_POLL_EXCEPT and retry PR_ConnectContinue later when PR_Poll() returns. -      - Other errors: the nonblocking connect has failed with this +- Other errors: the nonblocking connect has failed with this error code. -.. _Description: Description ----------- @@ -56,4 +52,4 @@ on the socket to determine whether the nonblocking connect has completed or is still in progress. Repeat the PR_Poll(), PR_ConnectContinue() sequence until the nonblocking connect has completed. -  + diff --git a/docs/nspr/reference/pr_convertipv4addrtoipv6.rst b/docs/nspr/reference/pr_convertipv4addrtoipv6.rst index dd6b42d60094..e51408242fdb 100644 --- a/docs/nspr/reference/pr_convertipv4addrtoipv6.rst +++ b/docs/nspr/reference/pr_convertipv4addrtoipv6.rst @@ -3,7 +3,6 @@ PR_ConvertIPv4AddrToIPv6 Converts an IPv4 address into an (IPv4-mapped) IPv6 address. -.. _Syntax: Syntax ~~~~~~ @@ -13,11 +12,10 @@ Syntax #include void PR_ConvertIPv4AddrToIPv6( -   PRUint32 v4addr, -   PRIPv6Addr *v6addr + PRUint32 v4addr, + PRIPv6Addr *v6addr ); -.. _Parameters: Parameters ~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_createfilemap.rst b/docs/nspr/reference/pr_createfilemap.rst index ed08fef13841..4223cb17c239 100644 --- a/docs/nspr/reference/pr_createfilemap.rst +++ b/docs/nspr/reference/pr_createfilemap.rst @@ -3,7 +3,6 @@ PR_CreateFileMap Creates a file mapping object. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRInt64 size, PRFileMapProtect prot); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -38,7 +36,6 @@ The function has the following parameters: - :ref:`PR_PROT_WRITECOPY`. Readable, and write is private (copy-on-write). -.. _Returns: Returns ~~~~~~~ @@ -46,7 +43,6 @@ Returns - If successful, a file mapping of type :ref:`PRFileMap`. - If unsuccessful, ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_createiolayerstub.rst b/docs/nspr/reference/pr_createiolayerstub.rst index 2493e385dcc7..919c3e1c8edb 100644 --- a/docs/nspr/reference/pr_createiolayerstub.rst +++ b/docs/nspr/reference/pr_createiolayerstub.rst @@ -3,7 +3,6 @@ PR_CreateIOLayerStub Creates a new layer. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRDescIdentity ident PRIOMethods const *methods); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -29,14 +27,12 @@ The function has the following parameters: A pointer to the :ref:`PRIOMethods` structure specifying the functions for the new layer. -.. _Returns: Returns ~~~~~~~ A new file descriptor for the specified layer. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_createpipe.rst b/docs/nspr/reference/pr_createpipe.rst index 4b0eb3fad3f6..227901d6a914 100644 --- a/docs/nspr/reference/pr_createpipe.rst +++ b/docs/nspr/reference/pr_createpipe.rst @@ -4,7 +4,6 @@ PR_CreatePipe Creates an anonymous pipe and retrieves file descriptors for the read and write ends of the pipe. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRFileDesc **readPipe, PRFileDesc **writePipe); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has the following parameters: A pointer to a :ref:`PRFileDesc` pointer. On return, this parameter contains the file descriptor for the write end of the pipe. -.. _Returns: Returns ~~~~~~~ @@ -42,7 +39,6 @@ The function returns one of these values: - If the pipe is not successfully created, ``PR_FAILURE``. The error code can be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_createthread.rst b/docs/nspr/reference/pr_createthread.rst index 5a0e4ff5ad48..b0a73b355189 100644 --- a/docs/nspr/reference/pr_createthread.rst +++ b/docs/nspr/reference/pr_createthread.rst @@ -3,7 +3,6 @@ PR_CreateThread Creates a new thread. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax PRThreadState state, PRUint32 stackSize); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -54,7 +52,6 @@ Parameters parameter, :ref:`PR_CreateThread` chooses the most favorable machine-specific stack size. -.. _Returns: Returns ~~~~~~~ @@ -66,7 +63,6 @@ The function returns one of the following values: - If unsuccessful, (for example, if system resources are unavailable), ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_createthreadpool.rst b/docs/nspr/reference/pr_createthreadpool.rst index 7f4c89a3d9eb..33039db5298a 100644 --- a/docs/nspr/reference/pr_createthreadpool.rst +++ b/docs/nspr/reference/pr_createthreadpool.rst @@ -3,7 +3,6 @@ PR_CreateThreadPool Create a new hash table. -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PRUint32 stacksize ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -34,14 +32,12 @@ The function has the following parameters: ``stacksize`` Size of the stack allocated to each thread in the thread. -.. _Returns: Returns ~~~~~~~ Pointer to a :ref:`PRThreadPool` structure or ``NULL`` on error. -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_cwait.rst b/docs/nspr/reference/pr_cwait.rst index 8a80709a5f37..5423b1034dc9 100644 --- a/docs/nspr/reference/pr_cwait.rst +++ b/docs/nspr/reference/pr_cwait.rst @@ -3,7 +3,6 @@ PR_CWait Wait for a notification that a monitor's state has changed. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax void *address, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -32,7 +30,6 @@ The function has the following parameters: rescheduled. If you specify ``PR_INTERVAL_NO_TIMEOUT``, the function returns if and only if the object is notified. -.. _Returns: Returns ~~~~~~~ @@ -46,7 +43,6 @@ The function returns one of the following values: in the cache or that the monitor was located and the calling thread was not the thread that held the monitor's mutex. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_delete.rst b/docs/nspr/reference/pr_delete.rst index f58797bf8d82..e65851552c65 100644 --- a/docs/nspr/reference/pr_delete.rst +++ b/docs/nspr/reference/pr_delete.rst @@ -1,7 +1,6 @@ PR_Delete ========= -.. _Syntax: Syntax ------ @@ -12,7 +11,6 @@ Syntax PRStatus PR_Delete(const char *name); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -22,7 +20,6 @@ The function has the following parameter: ``name`` The pathname of the file to be deleted. -.. _Returns: Returns ~~~~~~~ @@ -32,7 +29,6 @@ One of the following values: - If file is deleted successfully, ``PR_SUCCESS``. - If the file is not deleted, ``PR_FAILURE``. -.. _Description: Description ----------- @@ -41,4 +37,4 @@ Description the function fails, the error code can then be retrieved via :ref:`PR_GetError`. -  + diff --git a/docs/nspr/reference/pr_delete_.rst b/docs/nspr/reference/pr_delete_.rst index a468248e01a4..a0875497511e 100644 --- a/docs/nspr/reference/pr_delete_.rst +++ b/docs/nspr/reference/pr_delete_.rst @@ -4,7 +4,6 @@ PR_DELETE Allocates memory of a specified size from the heap. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax void PR_DELETE(_ptr); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,14 +23,12 @@ Parameter (an expression that can appear on the left side of an assignment statement). -.. _Returns: Returns ~~~~~~~ Nothing. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_deletesemaphore.rst b/docs/nspr/reference/pr_deletesemaphore.rst index b1de88331c45..7424a14e1c89 100644 --- a/docs/nspr/reference/pr_deletesemaphore.rst +++ b/docs/nspr/reference/pr_deletesemaphore.rst @@ -3,7 +3,6 @@ PR_DeleteSemaphore Removes a semaphore specified by name from the system. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax NSPR_API(PRStatus) PR_DeleteSemaphore(const char *name); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: The name of a semaphore that was previously created via a call to :ref:`PR_OpenSemaphore`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_deletesharedmemory.rst b/docs/nspr/reference/pr_deletesharedmemory.rst index 36b010e0c292..7f563782341f 100644 --- a/docs/nspr/reference/pr_deletesharedmemory.rst +++ b/docs/nspr/reference/pr_deletesharedmemory.rst @@ -3,7 +3,6 @@ PR_DeleteSharedMemory Deletes a shared memory segment identified by name. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax const char *name ); -.. _Parameter: Parameter ~~~~~~~~~ @@ -27,7 +25,6 @@ The function has these parameter: shm The handle returned from :ref:`PR_OpenSharedMemory`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_destroycondvar.rst b/docs/nspr/reference/pr_destroycondvar.rst index f0a924542f0f..5a4a93f2819b 100644 --- a/docs/nspr/reference/pr_destroycondvar.rst +++ b/docs/nspr/reference/pr_destroycondvar.rst @@ -3,7 +3,6 @@ PR_DestroyCondVar Destroys a condition variable. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_DestroyCondVar(PRCondVar *cvar); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ Parameter ``cvar`` A pointer to the condition variable object to be destroyed. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_destroylock.rst b/docs/nspr/reference/pr_destroylock.rst index 9ea1a3415ae5..028704646e5f 100644 --- a/docs/nspr/reference/pr_destroylock.rst +++ b/docs/nspr/reference/pr_destroylock.rst @@ -3,7 +3,6 @@ PR_DestroyLock Destroys a specified lock object. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_DestroyLock(PRLock *lock); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,8 +22,6 @@ Parameter ``lock`` A pointer to a lock object. -.. _Caution: - Caution ------- diff --git a/docs/nspr/reference/pr_destroymonitor.rst b/docs/nspr/reference/pr_destroymonitor.rst index 1bff509bde40..eb8a907c91fe 100644 --- a/docs/nspr/reference/pr_destroymonitor.rst +++ b/docs/nspr/reference/pr_destroymonitor.rst @@ -3,7 +3,6 @@ PR_DestroyMonitor Destroys a monitor object. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_DestroyMonitor(PRMonitor *mon); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``mon`` A reference to an existing structure of type :ref:`PRMonitor`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_destroypollableevent.rst b/docs/nspr/reference/pr_destroypollableevent.rst index a107eff2c28a..ebc167e57cfd 100644 --- a/docs/nspr/reference/pr_destroypollableevent.rst +++ b/docs/nspr/reference/pr_destroypollableevent.rst @@ -4,7 +4,6 @@ PR_DestroyPollableEvent Close the file descriptor associated with a pollable event and release related resources. -.. _Syntax: Syntax ------ @@ -13,7 +12,6 @@ Syntax NSPR_API(PRStatus) PR_DestroyPollableEvent(PRFileDesc *event); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: Pointer to a :ref:`PRFileDesc` structure previously created via a call to :ref:`PR_NewPollableEvent`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_detachsharedmemory.rst b/docs/nspr/reference/pr_detachsharedmemory.rst index 06f643201659..aab3f9c71f0d 100644 --- a/docs/nspr/reference/pr_detachsharedmemory.rst +++ b/docs/nspr/reference/pr_detachsharedmemory.rst @@ -3,7 +3,6 @@ PR_DetachSharedMemory Unmaps a shared memory segment identified by name. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax void *addr ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -30,7 +28,6 @@ shm addr The address to which the shared memory segment is mapped. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_detachthread.rst b/docs/nspr/reference/pr_detachthread.rst index 66a49e15fcda..5fbdd1939e7a 100644 --- a/docs/nspr/reference/pr_detachthread.rst +++ b/docs/nspr/reference/pr_detachthread.rst @@ -10,7 +10,6 @@ PR_DetachThread Disassociates a PRThread object from a native thread. -.. _Syntax: Syntax ------ @@ -21,21 +20,18 @@ Syntax void PR_DetachThread(void); -.. _Parameters: Parameters ~~~~~~~~~~ PR_DetachThread has no parameters. -.. _Returns: Returns ~~~~~~~ The function returns nothing. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_disableclockinterrupts.rst b/docs/nspr/reference/pr_disableclockinterrupts.rst index 9e36c91f7228..40fa133bc3dd 100644 --- a/docs/nspr/reference/pr_disableclockinterrupts.rst +++ b/docs/nspr/reference/pr_disableclockinterrupts.rst @@ -3,7 +3,6 @@ PR_DisableClockInterrupts Disables timer signals used for preemptive scheduling. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_dtoa.rst b/docs/nspr/reference/pr_dtoa.rst index 54a396db9087..0c6e55b15d46 100644 --- a/docs/nspr/reference/pr_dtoa.rst +++ b/docs/nspr/reference/pr_dtoa.rst @@ -3,7 +3,6 @@ PR_dtoa Converts a floating point number to a string. -.. _Syntax: Syntax ------ @@ -22,7 +21,6 @@ Syntax char *buf, PRSize bufsz); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -50,8 +48,6 @@ The function has these parameters: ``bufsz`` The size of the buffer provided to hold the result. -.. _Results: - Results ~~~~~~~ @@ -59,7 +55,6 @@ The principle output is the null-terminated string stored in ``buf``. If ``rve`` is not ``NULL``, ``*rve`` is set to point to the end of the returned value. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_entermonitor.rst b/docs/nspr/reference/pr_entermonitor.rst index 38090d688c18..816d89f155d5 100644 --- a/docs/nspr/reference/pr_entermonitor.rst +++ b/docs/nspr/reference/pr_entermonitor.rst @@ -3,7 +3,6 @@ PR_EnterMonitor Enters the lock associated with a specified monitor. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_EnterMonitor(PRMonitor *mon); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``mon`` A reference to an existing structure of type :ref:`PRMonitor`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_enumerateaddrinfo.rst b/docs/nspr/reference/pr_enumerateaddrinfo.rst index a62ff41e539f..2dc18f692ef1 100644 --- a/docs/nspr/reference/pr_enumerateaddrinfo.rst +++ b/docs/nspr/reference/pr_enumerateaddrinfo.rst @@ -5,7 +5,6 @@ PR_EnumerateAddrInfo Enumerates each of the possible network addresses of a ``PRAddrInfo`` structure, acquired from :ref:`PR_GetAddrInfoByName`. -.. _Syntax: Syntax ~~~~~~ @@ -20,7 +19,6 @@ Syntax PRUint16 port, PRNetAddr *result); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -44,7 +42,6 @@ The function has the following parameters: structure is filled in by the runtime if the result of the call is not ``NULL``. -.. _Returns: Returns ~~~~~~~ @@ -53,7 +50,6 @@ The function returns the value you should specify in the ``enumPtr`` parameter for the next call of the enumerator. If the function returns ``NULL``, the enumeration is ended. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_enumeratehostent.rst b/docs/nspr/reference/pr_enumeratehostent.rst index b9d8263902cd..d6d87bb4f26d 100644 --- a/docs/nspr/reference/pr_enumeratehostent.rst +++ b/docs/nspr/reference/pr_enumeratehostent.rst @@ -4,7 +4,6 @@ PR_EnumerateHostEnt Evaluates each of the possible addresses of a :ref:`PRHostEnt` structure, acquired from :ref:`PR_GetHostByName` or :ref:`PR_GetHostByAddr`. -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PRUint16 port, PRNetAddr *address); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -43,7 +41,6 @@ The function has the following parameters: structure is filled in by the runtime if the result of the call is greater than 0. -.. _Returns: Returns ~~~~~~~ @@ -56,7 +53,6 @@ The function returns one of the following values: - If unsuccessful, the function returns -1. You can retrieve the reason for the failure by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_exitmonitor.rst b/docs/nspr/reference/pr_exitmonitor.rst index 82c4773f4051..51344c27ba51 100644 --- a/docs/nspr/reference/pr_exitmonitor.rst +++ b/docs/nspr/reference/pr_exitmonitor.rst @@ -4,7 +4,6 @@ PR_ExitMonitor Decrements the entry count associated with a specified monitor and, if the entry count reaches zero, releases the monitor's lock. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRStatus PR_ExitMonitor(PRMonitor *mon); -.. _Parameter: Parameter ~~~~~~~~~ @@ -27,7 +25,6 @@ The function has the following parameter: monitor object referenced must be one for which the calling thread currently holds the lock. -.. _Returns: Returns ~~~~~~~ @@ -38,7 +35,6 @@ The function returns one of the following values: - If unsuccessful (the calling thread has not entered the monitor), ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_explodetime.rst b/docs/nspr/reference/pr_explodetime.rst index 897204c98999..4272e5d47c99 100644 --- a/docs/nspr/reference/pr_explodetime.rst +++ b/docs/nspr/reference/pr_explodetime.rst @@ -3,7 +3,6 @@ PR_ExplodeTime Converts an absolute time to a clock/calendar time. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRTimeParamFn params, PRExplodedTime *exploded); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -32,7 +30,6 @@ The function has these parameters: A pointer to a location where the converted time can be stored. This location must be preallocated by the caller. -.. _Returns: Returns ~~~~~~~ @@ -40,7 +37,6 @@ Returns Nothing; the buffer pointed to by ``exploded`` is filled with the exploded time. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_exportfilemapasstring.rst b/docs/nspr/reference/pr_exportfilemapasstring.rst index f26aa2a14415..9ff8c37e26f5 100644 --- a/docs/nspr/reference/pr_exportfilemapasstring.rst +++ b/docs/nspr/reference/pr_exportfilemapasstring.rst @@ -3,7 +3,6 @@ PR_ExportFileMapAsString Creates a string identifying a :ref:`PRFileMap`. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax #. define PR_FILEMAP_STRING_BUFSIZE 128 -.. _Parameters: Parameters ~~~~~~~~~~ @@ -35,14 +33,12 @@ The function has the following parameters: ``buf`` A pointer to abuffer of length ``PR_FILEMAP_STRING_BUFSIZE``. -.. _Returns: Returns ~~~~~~~ :ref:`PRStatus` -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_extern.rst b/docs/nspr/reference/pr_extern.rst index a2b65c74f1f9..12bdd2e7f2c5 100644 --- a/docs/nspr/reference/pr_extern.rst +++ b/docs/nspr/reference/pr_extern.rst @@ -4,7 +4,6 @@ PR_EXTERN Used to define the prototypes for functions or variables that are to be exported from a shared library. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PR_EXTERN(type)prototype -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_familyinet.rst b/docs/nspr/reference/pr_familyinet.rst index 693d6502f961..d27f94df697f 100644 --- a/docs/nspr/reference/pr_familyinet.rst +++ b/docs/nspr/reference/pr_familyinet.rst @@ -3,7 +3,6 @@ PR_FamilyInet Gets the value of the address family for Internet Protocol. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint16 PR_FamilyInet(void); -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_findsymbol.rst b/docs/nspr/reference/pr_findsymbol.rst index d2d05e317aa6..5be5bd13469b 100644 --- a/docs/nspr/reference/pr_findsymbol.rst +++ b/docs/nspr/reference/pr_findsymbol.rst @@ -5,7 +5,6 @@ PR_FindSymbol particular library given the identity of the library and a textual representation of the symbol in question. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRLibrary *lib, const char *name); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,14 +29,12 @@ The function has these parameters: ``name`` A textual representation of the symbol to resolve. -.. _Returns: Returns ~~~~~~~ An untyped pointer. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_findsymbolandlibrary.rst b/docs/nspr/reference/pr_findsymbolandlibrary.rst index c1123b3685cb..3acd8e26e9ff 100644 --- a/docs/nspr/reference/pr_findsymbolandlibrary.rst +++ b/docs/nspr/reference/pr_findsymbolandlibrary.rst @@ -4,7 +4,6 @@ PR_FindSymbolAndLibrary Finds a symbol in one of the currently loaded libraries, and returns both the symbol and the library in which it was found. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax const char *name, PRLibrary **lib); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has these parameters: in which the symbol was discovered. This location must be pre-allocated by the caller. -.. _Returns: Returns ~~~~~~~ @@ -42,7 +39,6 @@ pointed to by lib. If the symbol could not be found, returns ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_free.rst b/docs/nspr/reference/pr_free.rst index d265e80acd6a..c4ed8c84ca5f 100644 --- a/docs/nspr/reference/pr_free.rst +++ b/docs/nspr/reference/pr_free.rst @@ -3,7 +3,6 @@ PR_Free Frees allocated memory in the heap. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_Free(void *ptr); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,14 +20,12 @@ Parameter ``ptr`` A pointer to the memory to be freed. -.. _Returns: Returns ~~~~~~~ Nothing. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_freeaddrinfo.rst b/docs/nspr/reference/pr_freeaddrinfo.rst index 1921f1aeaae7..d8003839ef66 100644 --- a/docs/nspr/reference/pr_freeaddrinfo.rst +++ b/docs/nspr/reference/pr_freeaddrinfo.rst @@ -5,7 +5,6 @@ PR_FreeAddrInfo Destroys the ``PRAddrInfo`` structure returned by :ref:`PR_GetAddrInfoByName`. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax void PR_EnumerateAddrInfo(PRAddrInfo *addrInfo); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -27,7 +25,6 @@ The function has the following parameters: A pointer to a ``PRAddrInfo`` structure returned by a successful call to :ref:`PR_GetAddrInfoByName`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_freeif.rst b/docs/nspr/reference/pr_freeif.rst index 5950d039a42b..ef4ba0130b6e 100644 --- a/docs/nspr/reference/pr_freeif.rst +++ b/docs/nspr/reference/pr_freeif.rst @@ -3,7 +3,6 @@ PR_FREEIF Conditionally frees allocated memory. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_FREEIF(_ptr); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,14 +20,12 @@ Parameter ``_ptr`` The address of memory to be returned to the heap. -.. _Returns: Returns ~~~~~~~ Nothing. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_freelibraryname.rst b/docs/nspr/reference/pr_freelibraryname.rst index 5078c548f859..ad5811ccd1a2 100644 --- a/docs/nspr/reference/pr_freelibraryname.rst +++ b/docs/nspr/reference/pr_freelibraryname.rst @@ -3,7 +3,6 @@ PR_FreeLibraryName Frees memory allocated by NSPR for library names and path names. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_FreeLibraryName(char *mem); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -25,14 +23,12 @@ The function has this parameter: A reference to a character array that was previously allocated by the dynamic library runtime. -.. _Returns: Returns ~~~~~~~ Nothing. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getaddrinfobyname.rst b/docs/nspr/reference/pr_getaddrinfobyname.rst index 2da889de839d..0f5ac50519c7 100644 --- a/docs/nspr/reference/pr_getaddrinfobyname.rst +++ b/docs/nspr/reference/pr_getaddrinfobyname.rst @@ -4,7 +4,6 @@ PR_GetAddrInfoByName Looks up a host by name. Equivalent to ``getaddrinfo(host, NULL, ...)`` of RFC 3493. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRUint16 af, PRIntn flags); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -35,7 +33,6 @@ The function has the following parameters: ``PR_AI_NOCANONNAME`` to suppress the determination of the canonical name corresponding to ``hostname`` -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getcanonnamefromaddrinfo.rst b/docs/nspr/reference/pr_getcanonnamefromaddrinfo.rst index ffada940255b..856bc94512ab 100644 --- a/docs/nspr/reference/pr_getcanonnamefromaddrinfo.rst +++ b/docs/nspr/reference/pr_getcanonnamefromaddrinfo.rst @@ -4,7 +4,6 @@ PR_GetCanonNameFromAddrInfo Extracts the canonical name of the hostname passed to :ref:`PR_GetAddrInfoByName`. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax const char *PR_GetCanonNameFromAddrInfo(const PRAddrInfo *addrInfo); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameters: A pointer to a ``PRAddrInfo`` structure returned by a successful call to :ref:`PR_GetAddrInfoByName`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getconnectstatus.rst b/docs/nspr/reference/pr_getconnectstatus.rst index 2dfbafaea12b..718e9673def9 100644 --- a/docs/nspr/reference/pr_getconnectstatus.rst +++ b/docs/nspr/reference/pr_getconnectstatus.rst @@ -3,7 +3,6 @@ PR_GetConnectStatus Get the completion status of a nonblocking connection. -.. _Syntax: Syntax ------ @@ -12,7 +11,6 @@ Syntax PRStatus PR_GetConnectStatus(const PRPollDesc *pd); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: socket and whose ``in_flags`` field must contain ``PR_POLL_WRITE`` and ``PR_POLL_EXCEPT``. -.. _Returns: Returns ~~~~~~~ @@ -39,7 +36,6 @@ If :ref:`PR_GetError` returns ``PR_IN_PROGRESS_ERROR``, the nonblocking connection is still in progress and has not completed yet.Other errors indicate that the connection has failed. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getcurrentthread.rst b/docs/nspr/reference/pr_getcurrentthread.rst index 7ccf612cb870..837091b0ba69 100644 --- a/docs/nspr/reference/pr_getcurrentthread.rst +++ b/docs/nspr/reference/pr_getcurrentthread.rst @@ -3,7 +3,6 @@ PR_GetCurrentThread Returns the current thread object for the currently running code. -.. _Syntax: Syntax ------ @@ -14,14 +13,12 @@ Syntax PRThread* PR_GetCurrentThread(void); -.. _Returns: Returns ~~~~~~~ Always returns a valid reference to the calling thread--a self-identity. -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_getdefaultiomethods.rst b/docs/nspr/reference/pr_getdefaultiomethods.rst index eb516a66fbc8..4ed24e6f2194 100644 --- a/docs/nspr/reference/pr_getdefaultiomethods.rst +++ b/docs/nspr/reference/pr_getdefaultiomethods.rst @@ -3,7 +3,6 @@ PR_GetDefaultIOMethods Gets the default I/O methods table. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax const PRIOMethods* PR_GetDefaultIOMethods(void); -.. _Returns: Returns ~~~~~~~ @@ -22,7 +20,6 @@ Returns If successful, the function returns a pointer to a :ref:`PRIOMethods` structure. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getdesctype.rst b/docs/nspr/reference/pr_getdesctype.rst index d45e0bf6a7fa..d65ccc0a2eec 100644 --- a/docs/nspr/reference/pr_getdesctype.rst +++ b/docs/nspr/reference/pr_getdesctype.rst @@ -4,7 +4,6 @@ PR_GetDescType Describes what type of file is referenced by a specified file descriptor. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRDescType PR_GetDescType(PRFileDesc *file); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameter: A pointer to a :ref:`PRFileDesc` object whose descriptor type is to be returned. -.. _Returns: Returns ~~~~~~~ @@ -34,7 +31,6 @@ Returns The function returns a ``PRDescType`` enumeration constant that describes the type of file. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_geterror.rst b/docs/nspr/reference/pr_geterror.rst index e4cc13730f15..47ae66753fa0 100644 --- a/docs/nspr/reference/pr_geterror.rst +++ b/docs/nspr/reference/pr_geterror.rst @@ -3,7 +3,6 @@ PR_GetError Returns the current thread's last set platform-independent error code. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRErrorCode PR_GetError(void) -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_geterrortext.rst b/docs/nspr/reference/pr_geterrortext.rst index 155b370f0068..2d1e1affc786 100644 --- a/docs/nspr/reference/pr_geterrortext.rst +++ b/docs/nspr/reference/pr_geterrortext.rst @@ -4,7 +4,6 @@ PR_GetErrorText Copies the current thread's current error text without altering the text as stored in the thread's context. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRInt32 PR_GetErrorText(char *text); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ The function has one parameter: On output, the array pointed to contains the thread's current error text. -.. _Returns: Returns ------- diff --git a/docs/nspr/reference/pr_geterrortextlength.rst b/docs/nspr/reference/pr_geterrortextlength.rst index 5ca423b15809..e222f6c4d348 100644 --- a/docs/nspr/reference/pr_geterrortextlength.rst +++ b/docs/nspr/reference/pr_geterrortextlength.rst @@ -3,7 +3,6 @@ PR_GetErrorTextLength Gets the length of the error text. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRInt32 PR_GetErrorTextLength(void) -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getfileinfo.rst b/docs/nspr/reference/pr_getfileinfo.rst index 278d6172bd35..5391485cd654 100644 --- a/docs/nspr/reference/pr_getfileinfo.rst +++ b/docs/nspr/reference/pr_getfileinfo.rst @@ -4,7 +4,6 @@ PR_GetFileInfo Gets information about a file with a specified pathname. File size is expressed as a 32-bit integer. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax const char *fn, PRFileInfo *info); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has the following parameters: output, :ref:`PR_GetFileInfo` writes information about the given file to the file information object. -.. _Returns: Returns ~~~~~~~ @@ -41,7 +38,6 @@ One of the following values: - If the file information is successfully obtained, ``PR_SUCCESS``. - If the file information is not successfully obtained, ``PR_FAILURE``. -.. _Description: Description ----------- @@ -50,7 +46,6 @@ Description pathname in the :ref:`PRFileInfo` structure pointed to by ``info``. The file size is returned as an unsigned 32-bit integer. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_getfileinfo64.rst b/docs/nspr/reference/pr_getfileinfo64.rst index b684330f906e..08656248ea38 100644 --- a/docs/nspr/reference/pr_getfileinfo64.rst +++ b/docs/nspr/reference/pr_getfileinfo64.rst @@ -4,7 +4,6 @@ PR_GetFileInfo64 Gets information about a file with a specified pathname. File size is expressed as a 64-bit integer. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax const char *fn, PRFileInfo64 *info); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has the following parameters: On output, :ref:`PR_GetFileInfo64` writes information about the given file to the file information object. -.. _Returns: Returns ~~~~~~~ @@ -41,7 +38,6 @@ One of the following values: - If the file information is successfully obtained, ``PR_SUCCESS``. - If the file information is not successfully obtained, ``PR_FAILURE``. -.. _Description: Description ----------- @@ -50,7 +46,6 @@ Description specified pathname in the :ref:`PRFileInfo64` structure pointed to by ``info``. The file size is returned as an unsigned 64-bit integer. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_gethostbyaddr.rst b/docs/nspr/reference/pr_gethostbyaddr.rst index ea73423b0252..36a53b044fc9 100644 --- a/docs/nspr/reference/pr_gethostbyaddr.rst +++ b/docs/nspr/reference/pr_gethostbyaddr.rst @@ -3,7 +3,6 @@ PR_GetHostByAddr Looks up a host entry by its network address. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRIntn bufsize, PRHostEnt *hostentry); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -39,7 +37,6 @@ The function has the following parameters: This structure is allocated by the caller. On output, this structure is filled in by the runtime if the function returns ``PR_SUCCESS``. -.. _Returns: Returns ~~~~~~~ @@ -50,7 +47,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. You can retrieve the reason for the failure by calling :ref:`PR_GetError`. -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_gethostbyname.rst b/docs/nspr/reference/pr_gethostbyname.rst index 468a7d1794cf..e7562f7d0385 100644 --- a/docs/nspr/reference/pr_gethostbyname.rst +++ b/docs/nspr/reference/pr_gethostbyname.rst @@ -3,7 +3,6 @@ PR_GetHostByName Looks up a host by name. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRIntn bufsize, PRHostEnt *hostentry); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -39,7 +37,6 @@ The function has the following parameters: This structure is allocated by the caller. On output, this structure is filled in by the runtime if the function returns ``PR_SUCCESS``. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getidentitieslayer.rst b/docs/nspr/reference/pr_getidentitieslayer.rst index 1d3ddb109fec..5122cc8c0b97 100644 --- a/docs/nspr/reference/pr_getidentitieslayer.rst +++ b/docs/nspr/reference/pr_getidentitieslayer.rst @@ -4,7 +4,6 @@ PR_GetIdentitiesLayer Finds the layer with the specified identity in the specified stack of layers. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRFileDesc* stack, PRDescIdentity id); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -30,7 +28,6 @@ The function has the following parameters: ``id`` The identity of the specified layer. -.. _Returns: Returns ~~~~~~~ @@ -41,7 +38,6 @@ The function returns one of the following values: specified identity in the given stack of layers. - If not successful, ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getinheritedfilemap.rst b/docs/nspr/reference/pr_getinheritedfilemap.rst index 4767520160e1..ca617a3dcd09 100644 --- a/docs/nspr/reference/pr_getinheritedfilemap.rst +++ b/docs/nspr/reference/pr_getinheritedfilemap.rst @@ -4,7 +4,6 @@ PR_GetInheritedFileMap Imports a :ref:`PRFileMap` previously exported by my parent process via ``PR_CreateProcess``. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax const char *shmname ); -.. _Parameter: Parameter ~~~~~~~~~ @@ -28,14 +26,12 @@ The function has the following parameter: ``shmname`` The name provided to :ref:`PR_ProcessAttrSetInheritableFileMap`. -.. _Returns: Returns ~~~~~~~ Pointer to :ref:`PRFileMap` or ``NULL`` on error. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getlayersidentity.rst b/docs/nspr/reference/pr_getlayersidentity.rst index 8995a45ef1dd..d88c856ade11 100644 --- a/docs/nspr/reference/pr_getlayersidentity.rst +++ b/docs/nspr/reference/pr_getlayersidentity.rst @@ -3,7 +3,6 @@ PR_GetLayersIdentity Gets the unique identity for the layer of the specified file descriptor. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRDescIdentity PR_GetLayersIdentity(PRFileDesc* fd); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``fd`` A pointer to a file descriptor. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getlibraryname.rst b/docs/nspr/reference/pr_getlibraryname.rst index f364ff3ce7eb..1fe3f17bc871 100644 --- a/docs/nspr/reference/pr_getlibraryname.rst +++ b/docs/nspr/reference/pr_getlibraryname.rst @@ -3,7 +3,6 @@ PR_GetLibraryName Constructs a full library path name. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax const char *dir, const char *lib); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -29,7 +27,6 @@ The function has these parameters: ``lib`` The leaf name of the library of interest. -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ Returns If successful, returns a new character string containing a constructed path name. In case of error, returns ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getlibrarypath.rst b/docs/nspr/reference/pr_getlibrarypath.rst index 5292ebffd679..b360abf00111 100644 --- a/docs/nspr/reference/pr_getlibrarypath.rst +++ b/docs/nspr/reference/pr_getlibrarypath.rst @@ -3,7 +3,6 @@ PR_GetLibraryPath Retrieves the current default library path. -.. _Syntax: Syntax ------ @@ -14,14 +13,12 @@ Syntax char* PR_GetLibraryPath(void); -.. _Parameters: Parameters ~~~~~~~~~~ The function has no parameters. -.. _Returns: Returns ~~~~~~~ @@ -29,7 +26,6 @@ Returns A copy of the default library pathname string. In case of error, returns NULL. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getnameforidentity.rst b/docs/nspr/reference/pr_getnameforidentity.rst index 773782f37887..36543895fa14 100644 --- a/docs/nspr/reference/pr_getnameforidentity.rst +++ b/docs/nspr/reference/pr_getnameforidentity.rst @@ -3,7 +3,6 @@ PR_GetNameForIdentity Gets the string associated with a layer's unique identity. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax const char* PR_GetNameForIdentity(PRDescIdentity ident); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``ident`` A layer's identity. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ The function returns one of the following values: associated with the specified layer. - If unsuccessful, the function returns ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getopenfileinfo.rst b/docs/nspr/reference/pr_getopenfileinfo.rst index 37e8bf15fe1e..2e4c2fd3a812 100644 --- a/docs/nspr/reference/pr_getopenfileinfo.rst +++ b/docs/nspr/reference/pr_getopenfileinfo.rst @@ -4,7 +4,6 @@ PR_GetOpenFileInfo Gets an open file's information. File size is expressed as a 32-bit integer. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRFileDesc *fd, PRFileInfo *info); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -30,7 +28,6 @@ The function has the following parameters: A pointer to a :ref:`PRFileInfo` object. On output, information about the given file is written into the file information object. -.. _Returns: Returns ~~~~~~~ @@ -40,7 +37,6 @@ The function returns one of the following values: - If file information is successfully obtained, ``PR_SUCCESS``. - If file information is not successfully obtained, ``PR_FAILURE``. -.. _Description: Description ----------- @@ -49,7 +45,6 @@ Description other), file size (as a 32-bit integer), and the file creation and modification times of the open file represented by the file descriptor. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_getopenfileinfo64.rst b/docs/nspr/reference/pr_getopenfileinfo64.rst index c6171e52a325..fdc1aee262e8 100644 --- a/docs/nspr/reference/pr_getopenfileinfo64.rst +++ b/docs/nspr/reference/pr_getopenfileinfo64.rst @@ -4,7 +4,6 @@ PR_GetOpenFileInfo64 Gets an open file's information. File size is expressed as a 64-bit integer. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRFileDesc *fd, PRFileInfo *info); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -30,7 +28,6 @@ The function has the following parameters: A pointer to a :ref:`PRFileInfo64` object. On output, information about the given file is written into the file information object. -.. _Returns: Returns ~~~~~~~ @@ -40,7 +37,6 @@ The function returns one of the following values: - If file information is successfully obtained, ``PR_SUCCESS``. - If file information is not successfully obtained, ``PR_FAILURE``. -.. _Description: Description ----------- @@ -51,7 +47,6 @@ directory, or other), file size (as a 64-bit integer), and the creation and modification times of the open file represented by the file descriptor. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_getoserror.rst b/docs/nspr/reference/pr_getoserror.rst index 9f38489f318d..a3c4396a757e 100644 --- a/docs/nspr/reference/pr_getoserror.rst +++ b/docs/nspr/reference/pr_getoserror.rst @@ -3,7 +3,6 @@ PR_GetOSError Returns the current thread's last set OS-specific error code. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRInt32 PR_GetOSError(void) -.. _Returns: Returns ~~~~~~~ @@ -22,7 +20,6 @@ Returns The value returned is a 32-bit signed number. Its interpretation is left to the caller. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getpeername.rst b/docs/nspr/reference/pr_getpeername.rst index 388289fb53ef..b98c744d9bbf 100644 --- a/docs/nspr/reference/pr_getpeername.rst +++ b/docs/nspr/reference/pr_getpeername.rst @@ -3,7 +3,6 @@ PR_GetPeerName Gets the network address of the connected peer. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *fd, PRNetAddr *addr); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has the following parameters: ``addr`` On return, the address of the peer connected to the socket. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getprotobyname.rst b/docs/nspr/reference/pr_getprotobyname.rst index b36f88a7d15a..d30e3ac3951e 100644 --- a/docs/nspr/reference/pr_getprotobyname.rst +++ b/docs/nspr/reference/pr_getprotobyname.rst @@ -3,7 +3,6 @@ PR_GetProtoByName Looks up a protocol entry based on the protocol's name. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRInt32 bufsize, PRProtoEnt* result); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -38,7 +36,6 @@ The function has the following parameters: structure is filled in by the runtime if the function returns ``PR_SUCCESS``. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getprotobynumber.rst b/docs/nspr/reference/pr_getprotobynumber.rst index 7bb8e429b389..611a1d59a0a5 100644 --- a/docs/nspr/reference/pr_getprotobynumber.rst +++ b/docs/nspr/reference/pr_getprotobynumber.rst @@ -3,7 +3,6 @@ PR_GetProtoByNumber Looks up a protocol entry based on protocol's number. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRInt32 bufsize, PRProtoEnt* result); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -38,7 +36,6 @@ The function has the following parameters: structure is filled in by the runtime if the function returns ``PR_SUCCESS``. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getrandomnoise.rst b/docs/nspr/reference/pr_getrandomnoise.rst index b2853e50883b..62aeaf01d3c9 100644 --- a/docs/nspr/reference/pr_getrandomnoise.rst +++ b/docs/nspr/reference/pr_getrandomnoise.rst @@ -4,7 +4,6 @@ PR_GetRandomNoise Produces a random value for use as a seed value for another random number generator. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRSize size ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -32,7 +30,6 @@ The function has these parameters: ``size`` The size, in bytes, of the requested random number. -.. _Returns: Returns ~~~~~~~ @@ -43,7 +40,6 @@ requested. A return value of zero means that :ref:`PR_GetRandomNoise` is not implemented on this platform, or there is no available noise to be returned at the time of the call. -.. _Description: Description ----------- @@ -57,4 +53,4 @@ another random number generator that may be suitable for cryptographic operations. This implies that the random value provided may not be, by itself, cryptographically secure. The value generated by :ref:`PR_GetRandomNoise` is at best, extremely difficult to predict and is -as nondeterministic as the underlying platfrom permits. +as nondeterministic as the underlying platform permits. diff --git a/docs/nspr/reference/pr_getsocketoption.rst b/docs/nspr/reference/pr_getsocketoption.rst index 9bc442dbf528..f28b3a2578ff 100644 --- a/docs/nspr/reference/pr_getsocketoption.rst +++ b/docs/nspr/reference/pr_getsocketoption.rst @@ -3,7 +3,6 @@ PR_GetSocketOption Retrieves the socket options set for a specified socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *fd, PRSocketOptionData *data); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -33,7 +31,6 @@ The function has the following parameters: parameter. On output, this structure contains the requested socket option data. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getsockname.rst b/docs/nspr/reference/pr_getsockname.rst index a7d257810a89..036fc57225f5 100644 --- a/docs/nspr/reference/pr_getsockname.rst +++ b/docs/nspr/reference/pr_getsockname.rst @@ -3,7 +3,6 @@ PR_GetSockName Gets network address for a specified socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *fd, PRNetAddr *addr); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has the following parameters: ``addr`` On return, the address of the socket. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getspecialfd.rst b/docs/nspr/reference/pr_getspecialfd.rst index 23ff6d1c3e4a..7031436f7425 100644 --- a/docs/nspr/reference/pr_getspecialfd.rst +++ b/docs/nspr/reference/pr_getspecialfd.rst @@ -4,7 +4,6 @@ PR_GetSpecialFD Gets the file descriptor that represents the standard input, output, or error stream. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRFileDesc* PR_GetSpecialFD(PRSpecialFD id); -.. _Parameter: Parameter ~~~~~~~~~ @@ -27,7 +25,6 @@ The function has the following parameter: type of I/O stream desired: ``PR_StandardInput``, ``PR_StandardOutput``, or ``PR_StandardError``. -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ descriptor that represents the corresponding standard I/O stream. Otherwise, :ref:`PR_GetSpecialFD` returns ``NULL`` and sets the error to ``PR_INVALID_ARGUMENT_ERROR``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getthreadpriority.rst b/docs/nspr/reference/pr_getthreadpriority.rst index d9e48433839e..0edddfe7efc4 100644 --- a/docs/nspr/reference/pr_getthreadpriority.rst +++ b/docs/nspr/reference/pr_getthreadpriority.rst @@ -3,7 +3,6 @@ PR_GetThreadPriority Returns the priority of a specified thread. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRThreadPriority PR_GetThreadPriority(PRThread *thread); -.. _Parameter: Parameter ~~~~~~~~~ diff --git a/docs/nspr/reference/pr_getthreadprivate.rst b/docs/nspr/reference/pr_getthreadprivate.rst index e6483184047e..e2bf3669a350 100644 --- a/docs/nspr/reference/pr_getthreadprivate.rst +++ b/docs/nspr/reference/pr_getthreadprivate.rst @@ -3,7 +3,6 @@ PR_GetThreadPrivate Recovers the per-thread private data for the current thread. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void* PR_GetThreadPrivate(PRUintn index); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,14 +22,12 @@ Parameter ``index`` The index into the per-thread private data table. -.. _Returns: Returns ~~~~~~~ ``NULL`` if the data has not been set. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_getthreadscope.rst b/docs/nspr/reference/pr_getthreadscope.rst index 651dc7b36c35..2d539df2deb5 100644 --- a/docs/nspr/reference/pr_getthreadscope.rst +++ b/docs/nspr/reference/pr_getthreadscope.rst @@ -3,7 +3,6 @@ PR_GetThreadScope Gets the scoping of the current thread. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRThreadScope PR_GetThreadScope(void); -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_getuniqueidentity.rst b/docs/nspr/reference/pr_getuniqueidentity.rst index d6f2296b91b1..32dea22d3cb3 100644 --- a/docs/nspr/reference/pr_getuniqueidentity.rst +++ b/docs/nspr/reference/pr_getuniqueidentity.rst @@ -4,7 +4,6 @@ PR_GetUniqueIdentity Asks the runtime to allocate a unique identity for a layer identified by the layer's name. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRDescIdentity PR_GetUniqueIdentity(const char *layer_name); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: ``layer_name`` The string associated with the creation of a layer's identity. -.. _Returns: Returns ~~~~~~~ @@ -38,7 +35,6 @@ The function returns one of the following values: returns the value ``PR_INVALID_IO_LAYER`` with the error code ``PR_OUT_OF_MEMORY_ERROR``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_gmtparameters.rst b/docs/nspr/reference/pr_gmtparameters.rst index d096bb3d72ea..1e51232fb75c 100644 --- a/docs/nspr/reference/pr_gmtparameters.rst +++ b/docs/nspr/reference/pr_gmtparameters.rst @@ -9,7 +9,6 @@ Returns the time zone offset information that maps the specified **Note:** Since this function requires GMT as input, its primary use is as "filler" for cases in which you need a do-nothing callback. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax PRTimeParameters PR_GMTParameters ( const PRExplodedTime *gmt); -.. _Parameter: Parameter ~~~~~~~~~ @@ -30,7 +28,6 @@ Parameter A pointer to the clock/calendar time whose offsets are to be determined. This time should be specified in GMT. -.. _Returns: Returns ~~~~~~~ @@ -38,7 +35,6 @@ Returns A time parameters structure that expresses the time zone offsets at the specified time. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_htonl.rst b/docs/nspr/reference/pr_htonl.rst index 67a85c553530..8f3ff6ca2afb 100644 --- a/docs/nspr/reference/pr_htonl.rst +++ b/docs/nspr/reference/pr_htonl.rst @@ -3,7 +3,6 @@ PR_htonl Performs 32-bit conversion from host byte order to network byte order. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint32 PR_htonl(PRUint32 conversion); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``conversion`` The 32-bit unsigned integer, in host byte order, to be converted. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_htons.rst b/docs/nspr/reference/pr_htons.rst index 156c7a264bd5..7f734ec47659 100644 --- a/docs/nspr/reference/pr_htons.rst +++ b/docs/nspr/reference/pr_htons.rst @@ -3,7 +3,6 @@ PR_htons Performs 16-bit conversion from host byte order to network byte order. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint16 PR_htons(PRUint16 conversion); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``conversion`` The 16-bit unsigned integer, in host byte order, to be converted. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_implement.rst b/docs/nspr/reference/pr_implement.rst index 5f496164aeb3..a97f7441b9bc 100644 --- a/docs/nspr/reference/pr_implement.rst +++ b/docs/nspr/reference/pr_implement.rst @@ -4,7 +4,6 @@ PR_IMPLEMENT Used to define implementations of symbols that are to be exported from a shared library. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PR_IMPLEMENT(type)implementation -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_implodetime.rst b/docs/nspr/reference/pr_implodetime.rst index f0c0af4d4107..f204206a6ada 100644 --- a/docs/nspr/reference/pr_implodetime.rst +++ b/docs/nspr/reference/pr_implodetime.rst @@ -3,7 +3,6 @@ PR_ImplodeTime Converts a clock/calendar time to an absolute time. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRTime PR_ImplodeTime(const PRExplodedTime *exploded); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -24,14 +22,12 @@ The function has these parameters: ``exploded`` A pointer to the clock/calendar time to be converted. -.. _Returns: Returns ~~~~~~~ An absolute time value. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_importfilemapfromstring.rst b/docs/nspr/reference/pr_importfilemapfromstring.rst index 1bbdd47b6f60..2f71e53bba6f 100644 --- a/docs/nspr/reference/pr_importfilemapfromstring.rst +++ b/docs/nspr/reference/pr_importfilemapfromstring.rst @@ -3,7 +3,6 @@ PR_ImportFileMapFromString Creates a :ref:`PRFileMap` from an identifying string. -.. _Syntax: Syntax ~~~~~~ @@ -17,7 +16,6 @@ Syntax const char *fmstring ); -.. _Parameter: Parameter ~~~~~~~~~ @@ -27,14 +25,12 @@ The function has the following parameter: fmstring A pointer to string created by :ref:`PR_ExportFileMapAsString`. -.. _Returns: Returns ~~~~~~~ :ref:`PRFileMap` pointer or ``NULL`` on error. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_importtcpsocket.rst b/docs/nspr/reference/pr_importtcpsocket.rst index b5898ca56102..7a24579fcb1e 100644 --- a/docs/nspr/reference/pr_importtcpsocket.rst +++ b/docs/nspr/reference/pr_importtcpsocket.rst @@ -3,7 +3,6 @@ PR_ImportTCPSocket Imports a native TCP socket into NSPR. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRFileDesc* PR_ImportTCPSocket(PROsfd osfd); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameters: The native file descriptor for the TCP socket to import. On POSIX systems, this is an ``int``. On Windows, this is a ``SOCKET``. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ The function returns one of the following values: created for the newly imported native TCP socket. - If the import of the native TCP socket failed, ``NULL``. -.. _Description: Description ----------- @@ -60,8 +56,6 @@ on the native file descriptor. The caller must not do anything to the native file descriptor before the :ref:`PR_ImportTCPSocket` call that will prevent the native file descriptor from working in non-blocking mode. -.. _Warning: - Warning ------- diff --git a/docs/nspr/reference/pr_init.rst b/docs/nspr/reference/pr_init.rst index 9c4853b5469b..72dd4348ce42 100644 --- a/docs/nspr/reference/pr_init.rst +++ b/docs/nspr/reference/pr_init.rst @@ -3,7 +3,6 @@ PR_Init Initializes the runtime. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRThreadPriority priority, PRUintn maxPTDs); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ Parameters ``maxPTDs`` This parameter is ignored. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_init_clist.rst b/docs/nspr/reference/pr_init_clist.rst index 9dfb5739c875..4cde36589514 100644 --- a/docs/nspr/reference/pr_init_clist.rst +++ b/docs/nspr/reference/pr_init_clist.rst @@ -3,7 +3,6 @@ PR_INIT_CLIST Initializes a circular list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PR_INIT_CLIST (PRCList *listp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``listp`` A pointer to the anchor of the linked list. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_init_static_clist.rst b/docs/nspr/reference/pr_init_static_clist.rst index 6be9a966dd51..9d860cd9e384 100644 --- a/docs/nspr/reference/pr_init_static_clist.rst +++ b/docs/nspr/reference/pr_init_static_clist.rst @@ -3,7 +3,6 @@ PR_INIT_STATIC_CLIST Statically initializes a circular list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PR_INIT_STATIC_CLIST (PRCList *listp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``listp`` A pointer to the anchor of the linked list. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_initialize.rst b/docs/nspr/reference/pr_initialize.rst index ad12056440c8..6df1040cd300 100644 --- a/docs/nspr/reference/pr_initialize.rst +++ b/docs/nspr/reference/pr_initialize.rst @@ -5,7 +5,6 @@ Provides an alternate form of explicit initialization. In addition to establishing the sequence of operations, :ref:`PR_Initialize` implicitly calls :ref:`PR_Cleanup` on exiting the primordial function. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax char **argv, PRUintn maxPTDs); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -41,14 +39,12 @@ Parameters ``maxPTDs`` This parameter is ignored. -.. _Returns: Returns ~~~~~~~ The value returned from the root function, ``prmain``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_initialized.rst b/docs/nspr/reference/pr_initialized.rst index b72ec85f4ca7..ed958de31053 100644 --- a/docs/nspr/reference/pr_initialized.rst +++ b/docs/nspr/reference/pr_initialized.rst @@ -3,7 +3,6 @@ PR_Initialized Checks whether the runtime has been initialized. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRBool PR_Initialized(void); -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_initializenetaddr.rst b/docs/nspr/reference/pr_initializenetaddr.rst index 214b6f3bcb95..bba584ae78c0 100644 --- a/docs/nspr/reference/pr_initializenetaddr.rst +++ b/docs/nspr/reference/pr_initializenetaddr.rst @@ -5,7 +5,6 @@ Initializes or reinitializes a network address. The storage for the network address structure is allocated by, and remains the responsibility of, the calling client. -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PRUint16 port, PRNetAddr *addr); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -36,7 +34,6 @@ The function has the following parameters: ``addr`` A pointer to the :ref:`PRNetAddr` structure to be manipulated. -.. _Returns: Returns ~~~~~~~ @@ -49,7 +46,6 @@ The function returns one of the following values: You can retrieve the reason for the failure by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_insert_after.rst b/docs/nspr/reference/pr_insert_after.rst index 76c1f5b9de5a..ce421f41d54b 100644 --- a/docs/nspr/reference/pr_insert_after.rst +++ b/docs/nspr/reference/pr_insert_after.rst @@ -3,7 +3,6 @@ PR_INSERT_AFTER Inserts an element after another element in a circular list. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRCList *elemp1 PRCList *elemp2); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ Parameters ``elemp2`` A pointer to the element after which ``elemp1`` is to be inserted. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_insert_before.rst b/docs/nspr/reference/pr_insert_before.rst index 280d3bafc116..cd1a881e6681 100644 --- a/docs/nspr/reference/pr_insert_before.rst +++ b/docs/nspr/reference/pr_insert_before.rst @@ -3,7 +3,6 @@ PR_INSERT_BEFORE Inserts an element before another element in a circular list. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRCList *elemp1 PRCList *elemp2); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ Parameters ``elemp2`` A pointer to the element before which ``elemp1`` is to be inserted. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_insert_link.rst b/docs/nspr/reference/pr_insert_link.rst index 0d15633d985b..22a0fe2dabb6 100644 --- a/docs/nspr/reference/pr_insert_link.rst +++ b/docs/nspr/reference/pr_insert_link.rst @@ -3,7 +3,6 @@ PR_INSERT_LINK Inserts an element at the head of the list. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRCList *elemp, PRCList *listp); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ Parameters ``listp`` A pointer to the list. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_interrupt.rst b/docs/nspr/reference/pr_interrupt.rst index 696ae19eb832..fd4da04f8544 100644 --- a/docs/nspr/reference/pr_interrupt.rst +++ b/docs/nspr/reference/pr_interrupt.rst @@ -3,7 +3,6 @@ PR_Interrupt Sets the interrupt request for a target thread. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_Interrupt(PRThread *thread); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ Parameter ``thread`` The thread whose interrupt request you want to set. -.. _Returns: Returns ~~~~~~~ @@ -34,7 +31,6 @@ The function returns one of the following values: - If the specified thread is currently blocked, ``PR_SUCCESS``. - Otherwise, ``PR_FAILURE``. -.. _Description: Description ----------- @@ -56,8 +52,6 @@ was interrupted, compare the result of :ref:`PR_GetError` with :ref:`PR_Interrupt` may itself fail if the target thread is invalid. -.. _Bugs: - Bugs ---- diff --git a/docs/nspr/reference/pr_intervalnow.rst b/docs/nspr/reference/pr_intervalnow.rst index 90a3d044502d..acfa2d1e1170 100644 --- a/docs/nspr/reference/pr_intervalnow.rst +++ b/docs/nspr/reference/pr_intervalnow.rst @@ -3,7 +3,6 @@ PR_IntervalNow Returns the value of NSPR's free-running interval timer. -.. _Syntax: Syntax ------ @@ -14,14 +13,12 @@ Syntax PRIntervalTime PR_IntervalNow(void); -.. _Returns: Returns ~~~~~~~ A :ref:`PRIntervalTime` object. -.. _Description: Description ----------- @@ -52,4 +49,4 @@ call ``PR_IntervalNow()`` in a sequence that looks like this: } PR_Unlock(data->mutex); -  + diff --git a/docs/nspr/reference/pr_intervaltomicroseconds.rst b/docs/nspr/reference/pr_intervaltomicroseconds.rst index 98ac7cedb2d6..f03b3a09bff8 100644 --- a/docs/nspr/reference/pr_intervaltomicroseconds.rst +++ b/docs/nspr/reference/pr_intervaltomicroseconds.rst @@ -3,7 +3,6 @@ PR_IntervalToMicroseconds Converts platform-dependent intervals to standard clock microseconds. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint32 PR_IntervalToMicroseconds(PRIntervalTime ticks); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``ticks`` The number of platform-dependent intervals to convert. -.. _Returns: Returns ~~~~~~~ @@ -30,7 +27,6 @@ Returns Equivalent in microseconds of the value passed in the ``ticks`` parameter. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_intervaltomilliseconds.rst b/docs/nspr/reference/pr_intervaltomilliseconds.rst index db7b3b048f97..f51726eabacc 100644 --- a/docs/nspr/reference/pr_intervaltomilliseconds.rst +++ b/docs/nspr/reference/pr_intervaltomilliseconds.rst @@ -3,7 +3,6 @@ PR_IntervalToMilliseconds Converts platform-dependent intervals to standard clock milliseconds. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint32 PR_IntervalToMilliseconds(PRIntervalTime ticks); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``ticks`` The number of platform-dependent intervals to convert. -.. _Returns: Returns ~~~~~~~ @@ -30,7 +27,6 @@ Returns Equivalent in milliseconds of the value passed in the ``ticks`` parameter. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_intervaltoseconds.rst b/docs/nspr/reference/pr_intervaltoseconds.rst index e962040774d6..30c7a9bffdf0 100644 --- a/docs/nspr/reference/pr_intervaltoseconds.rst +++ b/docs/nspr/reference/pr_intervaltoseconds.rst @@ -3,7 +3,6 @@ PR_IntervalToSeconds Converts platform-dependent intervals to standard clock seconds. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint32 PR_IntervalToSeconds(PRIntervalTime ticks); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,14 +20,12 @@ Parameter ``ticks`` The number of platform-dependent intervals to convert. -.. _Returns: Returns ~~~~~~~ Equivalent in seconds of the value passed in the ``ticks`` parameter. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_joinjob.rst b/docs/nspr/reference/pr_joinjob.rst index 49a24f71c3e9..fdb64b328262 100644 --- a/docs/nspr/reference/pr_joinjob.rst +++ b/docs/nspr/reference/pr_joinjob.rst @@ -3,7 +3,6 @@ PR_JoinJob Blocks the current thread until a job has completed. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax NSPR_API(PRStatus) PR_JoinJob(PRJob *job); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: A pointer to a :ref:`PRJob` structure returned by a :ref:`PR_QueueJob` function representing the job to be cancelled. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_jointhread.rst b/docs/nspr/reference/pr_jointhread.rst index 7110b7b77f4d..66264462c101 100644 --- a/docs/nspr/reference/pr_jointhread.rst +++ b/docs/nspr/reference/pr_jointhread.rst @@ -3,7 +3,6 @@ PR_JoinThread Blocks the calling thread until a specified thread terminates. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_JoinThread(PRThread *thread); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ Parameter ``thread`` A valid identifier for the thread that is to be joined. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ The function returns one of the following values: corresponds to the specified target thread, or if the target thread is unjoinable--``PR_FAILURE``. -.. _Description: Description ----------- @@ -47,7 +43,7 @@ the target thread is in a joinable state. :ref:`PR_JoinThread` returns to the caller only after the target thread returns from its root function. :ref:`PR_JoinThread` must not be called until after :ref:`PR_CreateThread` has -returned.  If :ref:`PR_JoinThread` is not called on the same thread as +returned. If :ref:`PR_JoinThread` is not called on the same thread as :ref:`PR_CreateThread`, then it is the caller's responsibility to ensure that :ref:`PR_CreateThread` has completed. @@ -58,4 +54,4 @@ error ``PR_FAILURE``. The calling thread is not blocked if the target thread has already terminated. -:ref:`PR_JoinThread` is interruptable. +:ref:`PR_JoinThread` is interruptible. diff --git a/docs/nspr/reference/pr_jointhreadpool.rst b/docs/nspr/reference/pr_jointhreadpool.rst index c72e3df2a73e..b87b131ed260 100644 --- a/docs/nspr/reference/pr_jointhreadpool.rst +++ b/docs/nspr/reference/pr_jointhreadpool.rst @@ -4,7 +4,6 @@ PR_JoinThreadPool Waits for all threads in a thread pool to complete, then releases resources allocated to the thread pool. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax NSPR_API(PRStatus) PR_JoinThreadPool( PRThreadPool *tpool ); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameter: A pointer to a :ref:`PRThreadPool` structure previously created by a call to :ref:`PR_CreateThreadPool`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_list_head.rst b/docs/nspr/reference/pr_list_head.rst index 23734c8a83b8..096528e8458c 100644 --- a/docs/nspr/reference/pr_list_head.rst +++ b/docs/nspr/reference/pr_list_head.rst @@ -3,7 +3,6 @@ PR_LIST_HEAD Returns the head of a circular list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRCList *PR_LIST_HEAD (PRCList *listp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,14 +20,12 @@ Parameter ``listp`` A pointer to the linked list. -.. _Returns: Returns ~~~~~~~ A pointer to a list element. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_list_tail.rst b/docs/nspr/reference/pr_list_tail.rst index 228935485966..5b611b853f87 100644 --- a/docs/nspr/reference/pr_list_tail.rst +++ b/docs/nspr/reference/pr_list_tail.rst @@ -3,7 +3,6 @@ PR_LIST_TAIL Returns the tail of a circular list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRCList *PR_LIST_TAIL (PRCList *listp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,14 +20,12 @@ Parameter ``listp`` A pointer to the linked list. -.. _Returns: Returns ~~~~~~~ A pointer to a list element. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_listen.rst b/docs/nspr/reference/pr_listen.rst index 7ea8da71d16c..b23d152b443e 100644 --- a/docs/nspr/reference/pr_listen.rst +++ b/docs/nspr/reference/pr_listen.rst @@ -3,7 +3,6 @@ PR_Listen Listens for connections on a specified socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *fd, PRIntn backlog); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -29,7 +27,6 @@ The function has the following parameters: ``backlog`` The maximum length of the queue of pending connections. -.. _Returns: Returns ~~~~~~~ @@ -40,7 +37,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. Further information can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_loadlibrary.rst b/docs/nspr/reference/pr_loadlibrary.rst index 25336835488d..fee3412f856d 100644 --- a/docs/nspr/reference/pr_loadlibrary.rst +++ b/docs/nspr/reference/pr_loadlibrary.rst @@ -3,7 +3,6 @@ PR_LoadLibrary Loads a referenced library. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRLibrary* PR_LoadLibrary(const char *name); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -25,7 +23,6 @@ The function has this parameter: A platform-dependent character array that names the library to be loaded, as returned by :ref:`PR_GetLibraryName`. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ If successful, returns a reference to an opaque :ref:`PRLibrary` object. If the operation fails, returns ``NULL``. Use :ref:`PR_GetError` to find the reason for the failure. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_localtimeparameters.rst b/docs/nspr/reference/pr_localtimeparameters.rst index 582d7f0aa97b..399de676df51 100644 --- a/docs/nspr/reference/pr_localtimeparameters.rst +++ b/docs/nspr/reference/pr_localtimeparameters.rst @@ -4,7 +4,6 @@ PR_LocalTimeParameters Returns the time zone offset information that maps the specified :ref:`PRExplodedTime` to local time. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRTimeParameters PR_LocalTimeParameters ( const PRExplodedTime *gmt); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ Parameter A pointer to the clock/calendar time whose offsets are to be determined. This time should be specified in GMT. -.. _Returns: Returns ~~~~~~~ @@ -33,7 +30,6 @@ Returns A time parameters structure that expresses the time zone offsets at the specified time. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_lock.rst b/docs/nspr/reference/pr_lock.rst index 35b9abd36eec..5a09341242b9 100644 --- a/docs/nspr/reference/pr_lock.rst +++ b/docs/nspr/reference/pr_lock.rst @@ -3,7 +3,6 @@ PR_Lock Locks a specified lock object. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_Lock(PRLock *lock); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ Parameter ``lock`` A pointer to a lock object to be locked. -.. _Description: Description ----------- @@ -38,7 +35,6 @@ timeout mechanism. :ref:`PR_Lock` is not reentrant. Calling it twice on the same thread results in undefined behavior. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_malloc.rst b/docs/nspr/reference/pr_malloc.rst index bca76628f86e..7d998139e2ce 100644 --- a/docs/nspr/reference/pr_malloc.rst +++ b/docs/nspr/reference/pr_malloc.rst @@ -3,7 +3,6 @@ PR_MALLOC Allocates memory of a specified size from the heap. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void * PR_MALLOC(_bytes); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``_bytes`` Size of the requested memory block. -.. _Returns: Returns ~~~~~~~ @@ -31,7 +28,6 @@ An untyped pointer to the allocated memory, or if the allocation attempt fails, ``NULL``. Call ``PR_GetError()`` to retrieve the error returned by the libc function ``malloc()``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_memmap.rst b/docs/nspr/reference/pr_memmap.rst index a8d254456693..7dd922bf5f66 100644 --- a/docs/nspr/reference/pr_memmap.rst +++ b/docs/nspr/reference/pr_memmap.rst @@ -3,7 +3,6 @@ PR_MemMap Maps a section of a file to memory. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRInt64 offset, PRUint32 len); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -33,7 +31,6 @@ The function has the following parameters: ``len`` Length of the section of the file to be mapped. -.. _Returns: Returns ~~~~~~~ @@ -41,7 +38,6 @@ Returns The starting address of the memory region to which the section of file is mapped. Returns ``NULL`` on error. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_microsecondstointerval.rst b/docs/nspr/reference/pr_microsecondstointerval.rst index 8d7e685ecd8a..a82faabce455 100644 --- a/docs/nspr/reference/pr_microsecondstointerval.rst +++ b/docs/nspr/reference/pr_microsecondstointerval.rst @@ -3,7 +3,6 @@ PR_MicrosecondsToInterval Converts standard clock microseconds to platform-dependent intervals. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRIntervalTime PR_MicrosecondsToInterval(PRUint32 milli); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``micro`` The number of microseconds to convert to interval form. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_millisecondstointerval.rst b/docs/nspr/reference/pr_millisecondstointerval.rst index 2761b32b560c..ad5e8d43997f 100644 --- a/docs/nspr/reference/pr_millisecondstointerval.rst +++ b/docs/nspr/reference/pr_millisecondstointerval.rst @@ -3,7 +3,6 @@ PR_MillisecondsToInterval Converts standard clock milliseconds to platform-dependent intervals. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRIntervalTime PR_MillisecondsToInterval(PRUint32 milli); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``milli`` The number of milliseconds to convert to interval form. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_mkdir.rst b/docs/nspr/reference/pr_mkdir.rst index 457795c13895..7058f861f7aa 100644 --- a/docs/nspr/reference/pr_mkdir.rst +++ b/docs/nspr/reference/pr_mkdir.rst @@ -3,7 +3,6 @@ PR_MkDir Creates a directory with a specified name and access mode. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax const char *name, PRIntn mode); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -45,7 +43,6 @@ Possible values include the following: - :ref:`00002`. Write by others. - :ref:`00001`. Search by others. -.. _Returns: Returns ~~~~~~~ @@ -54,7 +51,6 @@ Returns - If unsuccessful, ``PR_FAILURE``. The actual reason can be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -64,7 +60,6 @@ path components up to but not including the leaf component must already exist. For example, if the pathname of the directory to be created is ``a/b/c/d``, the directory ``a/b/c`` must already exist. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_msec_per_sec.rst b/docs/nspr/reference/pr_msec_per_sec.rst index 9cdef2fda58f..9cdc49e44017 100644 --- a/docs/nspr/reference/pr_msec_per_sec.rst +++ b/docs/nspr/reference/pr_msec_per_sec.rst @@ -5,7 +5,6 @@ A convenience macro to improve code readability as well as to avoid mistakes in counting the number of zeros; represents the number of milliseconds in a second. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_name.rst b/docs/nspr/reference/pr_name.rst index a621801da937..85fb3b228a19 100644 --- a/docs/nspr/reference/pr_name.rst +++ b/docs/nspr/reference/pr_name.rst @@ -1,7 +1,6 @@ PR_NAME ======= -.. _Syntax: Syntax ------ @@ -12,7 +11,6 @@ Syntax #define PR_NAME "NSPR" -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_netaddrtostring.rst b/docs/nspr/reference/pr_netaddrtostring.rst index 756998d446b7..0f6e924eb802 100644 --- a/docs/nspr/reference/pr_netaddrtostring.rst +++ b/docs/nspr/reference/pr_netaddrtostring.rst @@ -3,7 +3,6 @@ PR_NetAddrToString Converts a character string to a network address. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax char *string, PRUint32 size); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has the following parameters: ``size`` The size of the result buffer (``string``). -.. _Returns: Returns ~~~~~~~ @@ -42,7 +39,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. You can retrieve the reason for the failure by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_netdb_buf_size.rst b/docs/nspr/reference/pr_netdb_buf_size.rst index f460e7b59a61..953d7d47d8c7 100644 --- a/docs/nspr/reference/pr_netdb_buf_size.rst +++ b/docs/nspr/reference/pr_netdb_buf_size.rst @@ -5,7 +5,6 @@ Recommended size to use when specifying a scratch buffer for :ref:`PR_GetHostByName`, :ref:`PR_GetHostByAddr`, :ref:`PR_GetProtoByName`, or :ref:`PR_GetProtoByNumber`. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_new.rst b/docs/nspr/reference/pr_new.rst index 5705a79e4da2..dd5d94c343d9 100644 --- a/docs/nspr/reference/pr_new.rst +++ b/docs/nspr/reference/pr_new.rst @@ -3,7 +3,6 @@ PR_NEW Allocates memory of a specified size from the heap. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax _type * PR_NEW(_struct); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``_struct`` The name of a type. -.. _Returns: Returns ~~~~~~~ @@ -31,7 +28,6 @@ An pointer to a buffer sized to contain the type ``_struct``, or if the allocation attempt fails, ``NULL``. Call ``PR_GetError()`` to retrieve the error returned by the libc function. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_newcondvar.rst b/docs/nspr/reference/pr_newcondvar.rst index 29374ec90a09..f67d0c9cadfe 100644 --- a/docs/nspr/reference/pr_newcondvar.rst +++ b/docs/nspr/reference/pr_newcondvar.rst @@ -3,7 +3,6 @@ PR_NewCondVar Creates a new condition variable. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRCondVar* PR_NewCondVar(PRLock *lock); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ Parameter The identity of the mutex that protects the monitored data, including this condition variable. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_newlock.rst b/docs/nspr/reference/pr_newlock.rst index 19cfd9fd1785..4090cee2e24a 100644 --- a/docs/nspr/reference/pr_newlock.rst +++ b/docs/nspr/reference/pr_newlock.rst @@ -3,7 +3,6 @@ PR_NewLock Creates a new lock. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRLock* PR_NewLock(void); -.. _Returns: Returns ~~~~~~~ @@ -25,7 +23,6 @@ The function returns one of the following values: - If unsuccessful (for example, the lock cannot be created because of resource constraints), ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_newmonitor.rst b/docs/nspr/reference/pr_newmonitor.rst index 6dda08c86174..61ce01e31227 100644 --- a/docs/nspr/reference/pr_newmonitor.rst +++ b/docs/nspr/reference/pr_newmonitor.rst @@ -4,7 +4,6 @@ PR_NewMonitor Creates a new monitor object. The caller is responsible for the object and is expected to destroy it when appropriate. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRMonitor* PR_NewMonitor(void); -.. _Returns: Returns ~~~~~~~ @@ -26,7 +24,6 @@ The function returns one of the following values: - If unsuccessful (for example, if some operating system resource is unavailable), ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_newpollableevent.rst b/docs/nspr/reference/pr_newpollableevent.rst index 8c6da99e7fab..313676c1b614 100644 --- a/docs/nspr/reference/pr_newpollableevent.rst +++ b/docs/nspr/reference/pr_newpollableevent.rst @@ -3,7 +3,6 @@ PR_NewPollableEvent Create a pollable event file descriptor. -.. _Syntax: Syntax ------ @@ -12,14 +11,12 @@ Syntax NSPR_API(PRFileDesc *) PR_NewPollableEvent( void); -.. _Parameter: Parameter ~~~~~~~~~ None. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_newprocessattr.rst b/docs/nspr/reference/pr_newprocessattr.rst index 3624f6a9565f..8eb1cb24800e 100644 --- a/docs/nspr/reference/pr_newprocessattr.rst +++ b/docs/nspr/reference/pr_newprocessattr.rst @@ -3,7 +3,6 @@ PR_NewProcessAttr Creates a process attributes structure. -.. _Syntax: Syntax ------ @@ -14,21 +13,18 @@ Syntax PRProcessAttr *PR_NewProcessAttr(void); -.. _Parameters: Parameters ~~~~~~~~~~ The function has no parameters. -.. _Returns: Returns ~~~~~~~ A pointer to the new process attributes structure. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_newtcpsocket.rst b/docs/nspr/reference/pr_newtcpsocket.rst index d6c800da249e..c8d20ea08d71 100644 --- a/docs/nspr/reference/pr_newtcpsocket.rst +++ b/docs/nspr/reference/pr_newtcpsocket.rst @@ -3,7 +3,6 @@ PR_NewTCPSocket Creates a new IPv4 TCP socket. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRFileDesc* PR_NewTCPSocket(void); -.. _Returns: Returns ~~~~~~~ @@ -25,7 +23,6 @@ The function returns one of the following values: created for the newly opened IPv4 TCP socket. - If the creation of a new TCP socket failed, ``NULL``. -.. _Description: Description ----------- @@ -49,7 +46,6 @@ read the client's first request in one function call. A TCP connection can be shut down by :ref:`PR_Shutdown`, and the sockets should be closed by :ref:`PR_Close`. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_newthreadprivateindex.rst b/docs/nspr/reference/pr_newthreadprivateindex.rst index fa9bc7f1d06b..ed951b6d3ba1 100644 --- a/docs/nspr/reference/pr_newthreadprivateindex.rst +++ b/docs/nspr/reference/pr_newthreadprivateindex.rst @@ -5,7 +5,6 @@ Returns a new index for a per-thread private data table and optionally associates a destructor with the data that will be assigned to the index. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRUintn *newIndex, PRThreadPrivateDTOR destructor); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -34,7 +32,6 @@ Parameters private data associated with the index. This function can be specified as ``NULL``. -.. _Returns: Returns ~~~~~~~ @@ -44,7 +41,6 @@ The function returns one of the following values: - If successful, ``PR_SUCCESS``. - If the total number of indices exceeds 128, ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_newudpsocket.rst b/docs/nspr/reference/pr_newudpsocket.rst index 55c7503906bc..94d3ef30cc3e 100644 --- a/docs/nspr/reference/pr_newudpsocket.rst +++ b/docs/nspr/reference/pr_newudpsocket.rst @@ -3,7 +3,6 @@ PR_NewUDPSocket Creates a new UDP socket. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRFileDesc* PR_NewUDPSocket(void); -.. _Returns: Returns ~~~~~~~ @@ -25,7 +23,6 @@ The function returns one of the following values: created for the newly opened UDP socket. - If the creation of a new UDP socket failed, ``NULL``. -.. _Description: Description ----------- @@ -39,7 +36,6 @@ a well-known port number with :ref:`PR_Bind`. Datagrams can be sent with :ref:`PR_SendTo` and received with :ref:`PR_RecvFrom`. When the socket is no longer needed, it should be closed with a call to :ref:`PR_Close`. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_newzap.rst b/docs/nspr/reference/pr_newzap.rst index 4a057460527a..b6c5edb99a27 100644 --- a/docs/nspr/reference/pr_newzap.rst +++ b/docs/nspr/reference/pr_newzap.rst @@ -4,7 +4,6 @@ PR_NEWZAP Allocates and clears memory from the heap for an instance of a given type. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax _type * PR_NEWZAP(_struct); -.. _Parameter: Parameter ~~~~~~~~~ @@ -23,7 +21,6 @@ Parameter ``_struct`` The name of a type. -.. _Returns: Returns ~~~~~~~ @@ -33,7 +30,6 @@ allocation attempt fails, ``NULL``. The bytes in the buffer are all initialized to 0. Call ``PR_GetError()`` to retrieve the error returned by the libc function. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_next_link.rst b/docs/nspr/reference/pr_next_link.rst index 5afe0e58fc0a..ef92e9cb1c54 100644 --- a/docs/nspr/reference/pr_next_link.rst +++ b/docs/nspr/reference/pr_next_link.rst @@ -3,7 +3,6 @@ PR_NEXT_LINK Returns the next element in a list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRCList *PR_NEXT_LINK (PRCList *elemp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,14 +20,12 @@ Parameter ``elemp`` A pointer to the element. -.. _Returns: Returns ~~~~~~~ A pointer to a list element. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_normalizetime.rst b/docs/nspr/reference/pr_normalizetime.rst index feec9614b875..5bae306e2909 100644 --- a/docs/nspr/reference/pr_normalizetime.rst +++ b/docs/nspr/reference/pr_normalizetime.rst @@ -4,7 +4,6 @@ PR_NormalizeTime Adjusts the fields of a clock/calendar time to their proper ranges, using a callback function. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRExplodedTime *time, PRTimeParamFn params); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -29,14 +27,12 @@ The function has these parameters: ``params`` A time parameter callback function. -.. _Returns: Returns ~~~~~~~ Nothing; the ``time`` parameter is altered by the callback function. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_notify.rst b/docs/nspr/reference/pr_notify.rst index 4c8b1d438ae6..88e25bbe5292 100644 --- a/docs/nspr/reference/pr_notify.rst +++ b/docs/nspr/reference/pr_notify.rst @@ -4,7 +4,6 @@ PR_Notify Notifies a monitor that a change in state of the monitored data has occurred. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRStatus PR_Notify(PRMonitor *mon); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -27,7 +25,6 @@ The function has the following parameter: monitor object referenced must be one for which the calling thread currently holds the lock. -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ The function returns one of the following values: - If successful, ``PR_SUCCESS``. - If unsuccessful, ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_notifyall.rst b/docs/nspr/reference/pr_notifyall.rst index 357b11f8c785..4ac1bff8d01e 100644 --- a/docs/nspr/reference/pr_notifyall.rst +++ b/docs/nspr/reference/pr_notifyall.rst @@ -3,7 +3,6 @@ PR_NotifyAll Promotes all threads waiting on a specified monitor to a ready state. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_NotifyAll(PRMonitor *mon); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameter: monitor object referenced must be one for which the calling thread currently holds the lock. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ The function returns one of the following values: - If successful, ``PR_SUCCESS``. - If unsuccessful, ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_notifyallcondvar.rst b/docs/nspr/reference/pr_notifyallcondvar.rst index 0a32de80514d..08351f79dd5b 100644 --- a/docs/nspr/reference/pr_notifyallcondvar.rst +++ b/docs/nspr/reference/pr_notifyallcondvar.rst @@ -3,7 +3,6 @@ PR_NotifyAllCondVar Notifies all of the threads waiting on a specified condition variable. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_NotifyAllCondVar(PRCondVar *cvar); -.. _Returns: Returns ~~~~~~~ @@ -25,7 +23,6 @@ The function returns one of the following values: - If unsuccessful (for example, if the caller has not locked the lock associated with the condition variable), ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_notifycondvar.rst b/docs/nspr/reference/pr_notifycondvar.rst index 22eb57ce2d58..1720080692fb 100644 --- a/docs/nspr/reference/pr_notifycondvar.rst +++ b/docs/nspr/reference/pr_notifycondvar.rst @@ -4,7 +4,6 @@ PR_NotifyCondVar Notifies a condition variable of a change in its associated monitored data. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRStatus PR_NotifyCondVar(PRCondVar *cvar); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ Parameter ``cvar`` The condition variable to notify. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ The function returns one of the following values: - If unsuccessful (for example, if the caller has not locked the lock associated with the condition variable), ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_now.rst b/docs/nspr/reference/pr_now.rst index 4703e0c845a8..2d4bcd6c51bf 100644 --- a/docs/nspr/reference/pr_now.rst +++ b/docs/nspr/reference/pr_now.rst @@ -3,7 +3,6 @@ PR_Now Returns the current time. -.. _Syntax: Syntax ------ @@ -14,21 +13,18 @@ Syntax PRTime PR_Now(void); -.. _Parameters: Parameters ~~~~~~~~~~ None. -.. _Returns: Returns ~~~~~~~ The current time as a :ref:`PRTime` value. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_nsec_per_msec.rst b/docs/nspr/reference/pr_nsec_per_msec.rst index 0154fac5d472..eb30ffc62a6f 100644 --- a/docs/nspr/reference/pr_nsec_per_msec.rst +++ b/docs/nspr/reference/pr_nsec_per_msec.rst @@ -5,7 +5,6 @@ A convenience macro to improve code readability as well as to avoid mistakes in counting the number of zeros; represents the number of nanoseconds in a millisecond. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_nsec_per_sec.rst b/docs/nspr/reference/pr_nsec_per_sec.rst index 3d4214344020..c35aab808af5 100644 --- a/docs/nspr/reference/pr_nsec_per_sec.rst +++ b/docs/nspr/reference/pr_nsec_per_sec.rst @@ -5,7 +5,6 @@ A convenience macro to improve code readability as well as to avoid mistakes in counting the number of zeros; represents the number of nanoseconds in a second. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_ntohl.rst b/docs/nspr/reference/pr_ntohl.rst index 8b21771cda8c..775a76cb97f1 100644 --- a/docs/nspr/reference/pr_ntohl.rst +++ b/docs/nspr/reference/pr_ntohl.rst @@ -3,7 +3,6 @@ PR_ntohl Performs 32-bit conversion from network byte order to host byte order. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint32 PR_ntohl(PRUint32 conversion); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``conversion`` The 32-bit unsigned integer, in network byte order, to be converted. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_ntohs.rst b/docs/nspr/reference/pr_ntohs.rst index b98996b0f691..9de7d3ea9dbb 100644 --- a/docs/nspr/reference/pr_ntohs.rst +++ b/docs/nspr/reference/pr_ntohs.rst @@ -3,7 +3,6 @@ PR_ntohs Performs 16-bit conversion from network byte order to host byte order. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRUint16 PR_ntohs(PRUint16 conversion); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``conversion`` The 16-bit unsigned integer, in network byte order, to be converted. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_open.rst b/docs/nspr/reference/pr_open.rst index c742fa7e1a0c..18a2c330df89 100644 --- a/docs/nspr/reference/pr_open.rst +++ b/docs/nspr/reference/pr_open.rst @@ -3,7 +3,6 @@ PR_Open Opens a file for reading, writing, or both. Also used to create a file. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRIntn flags, PRIntn mode); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -37,7 +35,7 @@ The function has the following parameters: .. note:: **NOTE**: The constants PR_RDWR and friends are not in any interface - (`bug 433295 `__). + (`bug 433295 `__). Thus they cannot be used in JavaScript, you have to use the octal constants (see `File I/O Snippets `__). @@ -70,7 +68,7 @@ The function has the following parameters: | | | and NULL is returned. | +--------------------+-------+---------------------------------------+ -  + ``mode`` When ``PR_CREATE_FILE`` flag is set and the file is created, these @@ -97,7 +95,6 @@ Name Value Description ``PR_IXOTH`` 0001 execute/search permission, others ============ ===== ===================================== -.. _Returns: Returns ~~~~~~~ @@ -109,7 +106,6 @@ The function returns one of the following values: :ref:`PRFileDesc` should be freed by calling :ref:`PR_Close`. - If the file was not opened successfully, a ``NULL`` pointer. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_openanonfilemap.rst b/docs/nspr/reference/pr_openanonfilemap.rst index ef5b61ab2bb1..c75a343d2e84 100644 --- a/docs/nspr/reference/pr_openanonfilemap.rst +++ b/docs/nspr/reference/pr_openanonfilemap.rst @@ -3,7 +3,6 @@ PR_OpenAnonFileMap Creates or opens a named semaphore with the specified name -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PRFileMapProtect prot ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -33,14 +31,12 @@ The function has the following parameters: ``prot`` How the shared memory is mapped. -.. _Returns: Returns ~~~~~~~ Pointer to :ref:`PRFileMap` or ``NULL`` on error. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_opendir.rst b/docs/nspr/reference/pr_opendir.rst index 3a647fc9cd87..1d66f4065318 100644 --- a/docs/nspr/reference/pr_opendir.rst +++ b/docs/nspr/reference/pr_opendir.rst @@ -3,7 +3,6 @@ PR_OpenDir Opens the directory with the specified pathname. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRDir* PR_OpenDir(const char *name); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``name`` The pathname of the directory to be opened. -.. _Returns: Returns ~~~~~~~ @@ -33,7 +30,6 @@ Returns dynamically allocated and the function returns a pointer to it. - If the directory cannot be opened, the function returns ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_opensemaphore.rst b/docs/nspr/reference/pr_opensemaphore.rst index 9896185cd39b..28d878f9d1ff 100644 --- a/docs/nspr/reference/pr_opensemaphore.rst +++ b/docs/nspr/reference/pr_opensemaphore.rst @@ -3,7 +3,6 @@ PR_OpenSemaphore Creates or opens a named semaphore with the specified name. -.. _Syntax: Syntax ------ @@ -23,7 +22,6 @@ Syntax PRUintn value ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -39,14 +37,12 @@ The function has the following parameters: ``value`` The initial value assigned to the semaphore. -.. _Returns: Returns ~~~~~~~ A pointer to a PRSem structure or ``NULL/code> on error.`` -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_opensharedmemory.rst b/docs/nspr/reference/pr_opensharedmemory.rst index aca63de08c61..1d8712428f34 100644 --- a/docs/nspr/reference/pr_opensharedmemory.rst +++ b/docs/nspr/reference/pr_opensharedmemory.rst @@ -4,7 +4,6 @@ PR_OpenSharedMemory Opens an existing shared memory segment or, if one with the specified name doesn't exist, creates a new one. -.. _Syntax: Syntax ------ @@ -25,7 +24,6 @@ Syntax #define PR_SHM_CREATE 0x1 /* create if not exist */ #define PR_SHM_EXCL 0x2 /* fail if already exists */ -.. _Parameters: Parameters ~~~~~~~~~~ @@ -41,7 +39,6 @@ flags mode Same as passed to :ref:`PR_Open`. -.. _Returns: Returns ~~~~~~~ @@ -50,7 +47,6 @@ Pointer to opaque structure ``PRSharedMemory``, or ``NULL`` if an error occurs. Retrieve the reason for the failure by calling :ref:`PR_GetError` and :ref:`PR_GetOSError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_opentcpsocket.rst b/docs/nspr/reference/pr_opentcpsocket.rst index c9593ec14f8d..b018a225f71c 100644 --- a/docs/nspr/reference/pr_opentcpsocket.rst +++ b/docs/nspr/reference/pr_opentcpsocket.rst @@ -3,7 +3,6 @@ PR_OpenTCPSocket Creates a new TCP socket of the specified address family. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRFileDesc* PR_OpenTCPSocket(PRIntn af); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameters: (IPv4), ``PR_AF_INET6`` (IPv6), or ``PR_AF_LOCAL`` (Unix domain, supported on POSIX systems only). -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ The function returns one of the following values: created for the newly opened TCP socket. - If the creation of a new TCP socket failed, ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_openudpsocket.rst b/docs/nspr/reference/pr_openudpsocket.rst index b0b9f944e159..f5fd19b108d8 100644 --- a/docs/nspr/reference/pr_openudpsocket.rst +++ b/docs/nspr/reference/pr_openudpsocket.rst @@ -3,7 +3,6 @@ PR_OpenUDPSocket Creates a new UDP socket of the specified address family. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRFileDesc* PR_OpenUDPSocket(PRIntn af); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ The function has the following parameters: (IPv4), ``PR_AF_INET6`` (IPv6), or ``PR_AF_LOCAL`` (Unix domain, supported on POSIX systems only). -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ The function returns one of the following values: created for the newly opened UDP socket. - If the creation of a new UDP socket failed, ``NULL``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_poll.rst b/docs/nspr/reference/pr_poll.rst index b11f46891acd..7c430e709048 100644 --- a/docs/nspr/reference/pr_poll.rst +++ b/docs/nspr/reference/pr_poll.rst @@ -3,7 +3,6 @@ PR_Poll Detects when I/O is ready for a set of socket file descriptors. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRIntn npds, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -35,7 +33,6 @@ The function has the following parameters: If this time expires without any I/O becoming ready, :ref:`PR_Poll` returns zero. -.. _Returns: Returns ~~~~~~~ @@ -48,7 +45,6 @@ The function returns one of these values: - The value -1 indicates the function failed. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ~~~~~~~~~~~ @@ -96,9 +92,9 @@ The structure has the following fields: ``in_flags`` A bitwise ``OR`` of the following bit flags: - - :ref:`PR_POLL_READ``: ``fd` is readable. - - :ref:`PR_POLL_WRITE``: ``fd` is writable. - - :ref:`PR_POLL_EXCEPT``: ``fd` has an exception condition. + - :ref:`PR_POLL_READ`: ``fd`` is readable. + - :ref:`PR_POLL_WRITE`: ``fd`` is writable. + - :ref:`PR_POLL_EXCEPT`: ``fd`` has an exception condition. ``out_flags`` A bitwise ``OR`` of the following bit flags: @@ -106,8 +102,8 @@ The structure has the following fields: - :ref:`PR_POLL_READ` - :ref:`PR_POLL_WRITE` - :ref:`PR_POLL_EXCEPT` - - :ref:`PR_POLL_ERR``: ``fd` has an error. - - :ref:`PR_POLL_NVAL``: ``fd` is bad. + - :ref:`PR_POLL_ERR`: ``fd`` has an error. + - :ref:`PR_POLL_NVAL`: ``fd`` is bad. Note that the ``PR_POLL_ERR`` and ``PR_POLL_NVAL`` flags are used only in ``out_flags``. The ``PR_POLL_ERR`` and ``PR_POLL_NVAL`` events are diff --git a/docs/nspr/reference/pr_popiolayer.rst b/docs/nspr/reference/pr_popiolayer.rst index dbcdcfbdba21..a50e502dbd75 100644 --- a/docs/nspr/reference/pr_popiolayer.rst +++ b/docs/nspr/reference/pr_popiolayer.rst @@ -3,7 +3,6 @@ PR_PopIOLayer Removes a layer from the stack. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *stack, PRDescIdentity id); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -29,7 +27,6 @@ The function has the following parameters: ``id`` Identity of the layer to be removed from the stack. -.. _Returns: Returns ~~~~~~~ @@ -42,7 +39,6 @@ The function returns one of the following values: example, the bottommost layer), the function returns ``NULL`` with the error code ``PR_INVALID_ARGUMENT_ERROR``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_postsemaphore.rst b/docs/nspr/reference/pr_postsemaphore.rst index 6a0b432cb3a0..ffd30990f80d 100644 --- a/docs/nspr/reference/pr_postsemaphore.rst +++ b/docs/nspr/reference/pr_postsemaphore.rst @@ -3,7 +3,6 @@ PR_PostSemaphore Increments the value of a specified semaphore. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax NSPR_API(PRStatus) PR_PostSemaphore(PRSem *sem); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: A pointer to a ``PRSem`` structure returned from a call to :ref:`PR_OpenSemaphore`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_prev_link.rst b/docs/nspr/reference/pr_prev_link.rst index a1c0f28f9645..7c94dccf472c 100644 --- a/docs/nspr/reference/pr_prev_link.rst +++ b/docs/nspr/reference/pr_prev_link.rst @@ -3,7 +3,6 @@ PR_PREV_LINK Returns the preceding element in a list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRCList *PR_PREV_LINK (PRCList *elemp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,14 +20,12 @@ Parameter ``elemp`` A pointer to the element. -.. _Returns: Returns ~~~~~~~ A pointer to a list element. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst b/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst index 5af0c241d3cc..302938b40cca 100644 --- a/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst +++ b/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst @@ -4,7 +4,6 @@ PR_ProcessAttrSetInheritableFileMap Prepare filemap for export to my children processes via ``PR_CreateProcess``. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax const char *shmname ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -35,14 +33,12 @@ The function has the following parameters: ``shmname`` Pointer to the name for the PRFileMap; used by child. -.. _Returns: Returns ~~~~~~~ :ref:`PRStatus` -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_processexit.rst b/docs/nspr/reference/pr_processexit.rst index 05c493cc3171..3db8411f4640 100644 --- a/docs/nspr/reference/pr_processexit.rst +++ b/docs/nspr/reference/pr_processexit.rst @@ -3,7 +3,6 @@ PR_ProcessExit Causes an immediate, nongraceful, forced termination of the process. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_ProcessExit(PRIntn status); -.. _Parameter: Parameter ~~~~~~~~~ diff --git a/docs/nspr/reference/pr_pushiolayer.rst b/docs/nspr/reference/pr_pushiolayer.rst index 6bbb9511030d..5d7a65e43e89 100644 --- a/docs/nspr/reference/pr_pushiolayer.rst +++ b/docs/nspr/reference/pr_pushiolayer.rst @@ -3,7 +3,6 @@ PR_PushIOLayer Adds a layer onto the stack. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRDescIdentity id, PRFileDesc *layer); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -33,7 +31,6 @@ The function has the following parameters: A pointer to a :ref:`PRFileDesc` object representing the new layer to be added to the stack. -.. _Returns: Returns ~~~~~~~ @@ -45,7 +42,6 @@ The function returns one of the following values: ``PR_FAILURE``. Use :ref:`PR_GetError` to get additional information regarding the reason for the failure. -.. _Description: Description ----------- @@ -60,8 +56,6 @@ the value of the file descriptor describing the original stack will not change. In other words, ``stack`` continues to point to the top of the stack after the function returns. -.. _Caution: - Caution ------- diff --git a/docs/nspr/reference/pr_queuejob.rst b/docs/nspr/reference/pr_queuejob.rst index 9c1b3cd36d01..fe984d281fa0 100644 --- a/docs/nspr/reference/pr_queuejob.rst +++ b/docs/nspr/reference/pr_queuejob.rst @@ -3,7 +3,6 @@ PR_QueueJob Queues a job to a thread pool for execution. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax PRBool joinable ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -38,7 +36,6 @@ The function has the following parameters: If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not joinable. See :ref:`PR_JoinJob`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_queuejob_connect.rst b/docs/nspr/reference/pr_queuejob_connect.rst index 231f37c842b8..3bc1f4c82fe9 100644 --- a/docs/nspr/reference/pr_queuejob_connect.rst +++ b/docs/nspr/reference/pr_queuejob_connect.rst @@ -3,7 +3,6 @@ PR_QueueJob_Connect Causes a job to be queued when a socket can be connected. -.. _Syntax: Syntax ------ @@ -22,7 +21,6 @@ Syntax PRBool joinable ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -44,7 +42,6 @@ The function has the following parameters: If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not joinable. See :ref:`PR_JoinJob`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_queuejob_read.rst b/docs/nspr/reference/pr_queuejob_read.rst index 4853318ded20..3ecf6124a007 100644 --- a/docs/nspr/reference/pr_queuejob_read.rst +++ b/docs/nspr/reference/pr_queuejob_read.rst @@ -3,7 +3,6 @@ PR_QueueJob_Read Causes a job to be queued when a socket becomes readable. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax PRBool joinable ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -41,7 +39,6 @@ The function has the following parameters: If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not joinable. See :ref:`PR_JoinJob`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_queuejob_timer.rst b/docs/nspr/reference/pr_queuejob_timer.rst index 63c6113327e8..352e78efd79f 100644 --- a/docs/nspr/reference/pr_queuejob_timer.rst +++ b/docs/nspr/reference/pr_queuejob_timer.rst @@ -3,7 +3,6 @@ PR_QueueJob_Timer Causes a job to be queued when a timer expires. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax PRBool joinable ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -44,7 +42,6 @@ The function has the following parameters: If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not joinable. See :ref:`PR_JoinJob`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_queuejob_write.rst b/docs/nspr/reference/pr_queuejob_write.rst index 84ad68e4a3f4..99fb6a3b585a 100644 --- a/docs/nspr/reference/pr_queuejob_write.rst +++ b/docs/nspr/reference/pr_queuejob_write.rst @@ -3,7 +3,6 @@ PR_QueueJob_Write Causes a job to be queued when a socket becomes writable. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax PRBool joinable ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -41,7 +39,6 @@ The function has the following parameters: If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not joinable. See :ref:`PR_JoinJob`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_queuejobaccept.rst b/docs/nspr/reference/pr_queuejobaccept.rst index 8fb0fa762314..a4c74ed847b3 100644 --- a/docs/nspr/reference/pr_queuejobaccept.rst +++ b/docs/nspr/reference/pr_queuejobaccept.rst @@ -3,7 +3,6 @@ PR_QueueJob_Accept Causes a job to be queued when a socket has a pending connection. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax PRBool joinable ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -41,7 +39,6 @@ The function has the following parameters: If ``PR_TRUE``, the job is joinable. If ``PR_FALSE``, the job is not joinable. See :ref:`PR_JoinJob`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_read.rst b/docs/nspr/reference/pr_read.rst index d0085aed3fd5..9e152d048414 100644 --- a/docs/nspr/reference/pr_read.rst +++ b/docs/nspr/reference/pr_read.rst @@ -3,7 +3,6 @@ PR_Read Reads bytes from a file or socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax void *buf, PRInt32 amount); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has the following parameters: ``amount`` The size of ``buf`` (in bytes). -.. _Returns: Returns ~~~~~~~ @@ -44,7 +41,6 @@ One of the following values: - The value -1 indicates a failure. To get the reason for the failure, call :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_readdir.rst b/docs/nspr/reference/pr_readdir.rst index 123d7f50cef3..cd639294a2d8 100644 --- a/docs/nspr/reference/pr_readdir.rst +++ b/docs/nspr/reference/pr_readdir.rst @@ -3,7 +3,6 @@ PR_ReadDir Gets a pointer to the next entry in the directory. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRDir *dir, PRDirFlags flags); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -40,7 +38,6 @@ The function has the following parameters: attribute set. On Unix platform, this value identifies files whose names begin with a period ("."). -.. _Returns: Returns ~~~~~~~ @@ -49,7 +46,6 @@ Returns - If the end of the directory is reached or an error occurs, ``NULL``. The reason can be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -90,7 +86,6 @@ on the same :ref:`PRDir` object. If the end of the directory is reached, :ref:`PR_ReadDir` returns ``NULL``, and :ref:`PR_GetError` returns ``PR_NO_MORE_FILES_ERROR``. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_realloc.rst b/docs/nspr/reference/pr_realloc.rst index 3b26a5ee5f61..5f0d7617a0a5 100644 --- a/docs/nspr/reference/pr_realloc.rst +++ b/docs/nspr/reference/pr_realloc.rst @@ -4,7 +4,6 @@ PR_Realloc Resizes allocated memory on the heap. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax void *ptr, PRUint32 size); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -27,7 +25,6 @@ Parameters ``size`` The size of the new memory block. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ An untyped pointer to the allocated memory, or if the allocation attempt fails, ``NULL``. Call ``PR_GetError()`` to retrieve the error returned by the libc function ``realloc()``. -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/pr_recv.rst b/docs/nspr/reference/pr_recv.rst index 21b348716b2c..31928a9137be 100644 --- a/docs/nspr/reference/pr_recv.rst +++ b/docs/nspr/reference/pr_recv.rst @@ -3,7 +3,6 @@ PR_Recv Receives bytes from a connected socket. -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PRIntn flags, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -38,7 +36,6 @@ The function has the following parameters: A value of type :ref:`PRIntervalTime` specifying the time limit for completion of the receive operation. -.. _Returns: Returns ~~~~~~~ @@ -50,7 +47,6 @@ The function returns one of the following values: - The value -1 indicates a failure. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_recvfrom.rst b/docs/nspr/reference/pr_recvfrom.rst index c013909e44c2..179c0b423983 100644 --- a/docs/nspr/reference/pr_recvfrom.rst +++ b/docs/nspr/reference/pr_recvfrom.rst @@ -3,7 +3,6 @@ PR_RecvFrom Receives bytes from a socket and stores the sending peer's address. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax PRNetAddr *addr, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -42,7 +40,6 @@ The function has the following parameters: A value of type :ref:`PRIntervalTime` specifying the time limit for completion of the receive operation. -.. _Returns: Returns ~~~~~~~ @@ -54,7 +51,6 @@ The function returns one of the following values: - The value -1 indicates a failure. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_remove_and_init_link.rst b/docs/nspr/reference/pr_remove_and_init_link.rst index 96d292fb324b..d48bf651278d 100644 --- a/docs/nspr/reference/pr_remove_and_init_link.rst +++ b/docs/nspr/reference/pr_remove_and_init_link.rst @@ -3,7 +3,6 @@ PR_REMOVE_AND_INIT_LINK Removes an element from a circular list and initializes the linkage. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PR_REMOVE_AND_INIT_LINK (PRCList *elemp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``elemp`` A pointer to the element. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_remove_link.rst b/docs/nspr/reference/pr_remove_link.rst index 0938f6a364ac..c54c1a0617d7 100644 --- a/docs/nspr/reference/pr_remove_link.rst +++ b/docs/nspr/reference/pr_remove_link.rst @@ -3,7 +3,6 @@ PR_REMOVE_LINK Removes an element from a circular list. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PR_REMOVE_LINK (PRCList *elemp); -.. _Parameter: Parameter ~~~~~~~~~ @@ -22,7 +20,6 @@ Parameter ``elemp`` A pointer to the element. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_rename.rst b/docs/nspr/reference/pr_rename.rst index 60a1cf15d7cd..823378e066b9 100644 --- a/docs/nspr/reference/pr_rename.rst +++ b/docs/nspr/reference/pr_rename.rst @@ -3,7 +3,6 @@ PR_Rename Renames a file. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax const char *from, const char *to); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has the following parameters: ``to`` The new name of the file. -.. _Returns: Returns ~~~~~~~ @@ -38,7 +35,6 @@ One of the following values: - If file is successfully renamed, ``PR_SUCCESS``. - If file is not successfully renamed, ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_rmdir.rst b/docs/nspr/reference/pr_rmdir.rst index e484c1533ced..62fa82c4750a 100644 --- a/docs/nspr/reference/pr_rmdir.rst +++ b/docs/nspr/reference/pr_rmdir.rst @@ -3,7 +3,6 @@ PR_RmDir Removes a directory with a specified name. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_RmDir(const char *name); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``name`` The name of the directory to be removed. -.. _Returns: Returns ~~~~~~~ @@ -33,7 +30,6 @@ Returns - If unsuccessful, ``PR_FAILURE``. The actual reason can be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -43,7 +39,6 @@ The directory must be empty. If the directory is not empty, :ref:`PR_RmDir` fails and :ref:`PR_GetError` returns the error code ``PR_DIRECTORY_NOT_EMPTY_ERROR``. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_secondstointerval.rst b/docs/nspr/reference/pr_secondstointerval.rst index 5d19fa5fb950..411030a7e66e 100644 --- a/docs/nspr/reference/pr_secondstointerval.rst +++ b/docs/nspr/reference/pr_secondstointerval.rst @@ -3,7 +3,6 @@ PR_SecondsToInterval Converts standard clock seconds to platform-dependent intervals. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRIntervalTime PR_SecondsToInterval(PRUint32 seconds); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: ``seconds`` The number of seconds to convert to interval form. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_seek.rst b/docs/nspr/reference/pr_seek.rst index e5983f12ebc7..b6a4591d862d 100644 --- a/docs/nspr/reference/pr_seek.rst +++ b/docs/nspr/reference/pr_seek.rst @@ -18,7 +18,6 @@ Moves the current read-write file pointer by an offset expressed as a Deprecated in favor of :ref:`PR_Seek64`. -.. _Syntax: Syntax ~~~~~~ @@ -32,7 +31,6 @@ Syntax PRInt32 offset, PRSeekWhence whence); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -57,7 +55,6 @@ The function has the following parameters: - :ref:`PR_SEEK_END`. Sets the file pointer to the size of the file plus the value of the ``offset`` parameter. -.. _Returns: Returns ~~~~~~~ @@ -70,7 +67,6 @@ The function returns one of the following values: function returns -1. The error code can then be retrieved with :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -80,7 +76,6 @@ for the file descriptor ``fd``: ``PR_Seek(fd, 0, PR_SEEK_CUR)`` -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_seek64.rst b/docs/nspr/reference/pr_seek64.rst index 4ee1ee52382a..6c87f552932a 100644 --- a/docs/nspr/reference/pr_seek64.rst +++ b/docs/nspr/reference/pr_seek64.rst @@ -4,7 +4,6 @@ PR_Seek64 Moves the current read-write file pointer by an offset expressed as a 64-bit integer. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRInt64 offset, PRSeekWhence whence); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -43,7 +41,6 @@ The function has the following parameters: - :ref:`PR_SEEK_END`. Sets the file pointer to the size of the file plus the value of the ``offset`` parameter. -.. _Returns: Returns ~~~~~~~ @@ -56,7 +53,6 @@ The function returns one of the following values: function returns -1. The error code can then be retrieved with :ref:`PR_GetError`. -.. _Description: Description ----------- @@ -70,7 +66,6 @@ If the operating system can handle only a 32-bit file offset, :ref:`PR_Seek64` may fail with the error code ``PR_FILE_TOO_BIG_ERROR`` if the ``offset`` parameter is out of the range of a 32-bit integer. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_send.rst b/docs/nspr/reference/pr_send.rst index 54ebfb244cb5..356c20e48dbc 100644 --- a/docs/nspr/reference/pr_send.rst +++ b/docs/nspr/reference/pr_send.rst @@ -3,7 +3,6 @@ PR_Send Sends bytes from a connected socket. -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PRIntn flags, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -38,7 +36,6 @@ The function has the following parameters: A value of type :ref:`PRIntervalTime` specifying the time limit for completion of the receive operation. -.. _Returns: Returns ~~~~~~~ @@ -51,7 +48,6 @@ The function returns one of the following values: - The value -1 indicates a failure. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_sendto.rst b/docs/nspr/reference/pr_sendto.rst index ef42e504b60f..1ceb93249afa 100644 --- a/docs/nspr/reference/pr_sendto.rst +++ b/docs/nspr/reference/pr_sendto.rst @@ -3,7 +3,6 @@ PR_SendTo Sends bytes a socket to a specified destination. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax const PRNetAddr *addr, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -41,7 +39,6 @@ The function has the following parameters: A value of type :ref:`PRIntervalTime` specifying the time limit for completion of the receive operation. -.. _Returns: Returns ~~~~~~~ @@ -52,7 +49,6 @@ The function returns one of the following values: - The value -1 indicates a failure. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_setconcurrency.rst b/docs/nspr/reference/pr_setconcurrency.rst index 817e2a8f8ea0..c3584decf52d 100644 --- a/docs/nspr/reference/pr_setconcurrency.rst +++ b/docs/nspr/reference/pr_setconcurrency.rst @@ -3,7 +3,6 @@ PR_SetConcurrency Creates extra virtual processor threads. Generally used with MP systems. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_SetConcurrency(PRUintn numCPUs); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ Parameter ``numCPUs`` The number of extra virtual processor threads to be created. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_seterror.rst b/docs/nspr/reference/pr_seterror.rst index f98a69c68ba5..7488e57b1e38 100644 --- a/docs/nspr/reference/pr_seterror.rst +++ b/docs/nspr/reference/pr_seterror.rst @@ -3,7 +3,6 @@ PR_SetError Sets error information within a thread context. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_SetError(PRErrorCode errorCode, PRInt32 oserr) -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has these parameters: The platform-specific error. If there is no appropriate OS error number, a zero may be supplied. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_seterrortext.rst b/docs/nspr/reference/pr_seterrortext.rst index e0a3e6adba2f..41904c3e5ccc 100644 --- a/docs/nspr/reference/pr_seterrortext.rst +++ b/docs/nspr/reference/pr_seterrortext.rst @@ -3,7 +3,6 @@ PR_SetErrorText Sets the text associated with an error. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax void PR_SetErrorText(PRIntn textLength, const char *text) -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has these parameters: ``text`` The text to associate with the error. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_setlibrarypath.rst b/docs/nspr/reference/pr_setlibrarypath.rst index eea5cf9923e0..454ff9f39cf0 100644 --- a/docs/nspr/reference/pr_setlibrarypath.rst +++ b/docs/nspr/reference/pr_setlibrarypath.rst @@ -3,7 +3,6 @@ PR_SetLibraryPath Registers a default library pathname with a runtime. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_SetLibraryPath(const char *path); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -27,7 +25,6 @@ The function has this parameter: is not defined, nor whether that pathname should be absolute or relative. -.. _Returns: Returns ~~~~~~~ @@ -38,7 +35,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. This may indicate that the function cannot allocate sufficient storage to make a copy of the path string -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_setpollableevent.rst b/docs/nspr/reference/pr_setpollableevent.rst index 3c5e4614ba7d..ecc3ee85cfc0 100644 --- a/docs/nspr/reference/pr_setpollableevent.rst +++ b/docs/nspr/reference/pr_setpollableevent.rst @@ -3,7 +3,6 @@ PR_SetPollableEvent Set a pollable event. -.. _Syntax: Syntax ------ @@ -12,7 +11,6 @@ Syntax NSPR_API(PRStatus) PR_SetPollableEvent(PRFileDesc *event); -.. _Parameter: Parameter ~~~~~~~~~ @@ -23,7 +21,6 @@ The function has the following parameter: Pointer to a :ref:`PRFileDesc` structure previously created via a call to :ref:`PR_NewPollableEvent`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_setsocketoption.rst b/docs/nspr/reference/pr_setsocketoption.rst index 72480f090f8b..5191769324e7 100644 --- a/docs/nspr/reference/pr_setsocketoption.rst +++ b/docs/nspr/reference/pr_setsocketoption.rst @@ -3,7 +3,6 @@ PR_SetSocketOption Retrieves the socket options set for a specified socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *fd, PRSocketOptionData *data); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -30,7 +28,6 @@ The function has the following parameters: A pointer to a structure of type :ref:`PRSocketOptionData` specifying the options to set. -.. _Returns: Returns ~~~~~~~ @@ -39,7 +36,6 @@ Returns - If unsuccessful, ``PR_FAILURE``. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_setthreadpriority.rst b/docs/nspr/reference/pr_setthreadpriority.rst index 1304c4ecafba..8d69fb8e2711 100644 --- a/docs/nspr/reference/pr_setthreadpriority.rst +++ b/docs/nspr/reference/pr_setthreadpriority.rst @@ -3,7 +3,6 @@ PR_SetThreadPriority Sets the priority of a specified thread. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRThread *thread, PRThreadPriority priority); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ Parameters ``priority`` The priority you want to set. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_setthreadprivate.rst b/docs/nspr/reference/pr_setthreadprivate.rst index 0266ba363749..20a69aca4aea 100644 --- a/docs/nspr/reference/pr_setthreadprivate.rst +++ b/docs/nspr/reference/pr_setthreadprivate.rst @@ -3,7 +3,6 @@ PR_SetThreadPrivate Sets per-thread private data. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_SetThreadPrivate(PRUintn index, void *priv); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -26,7 +24,6 @@ Parameters ``priv`` The per-thread private data, or more likely, a pointer to the data. -.. _Returns: Returns ~~~~~~~ @@ -36,7 +33,6 @@ The function returns one of the following values: - If successful, ``PR_SUCCESS``. - If the index is invalid, ``PR_FAILURE``. -.. _Description: Description ----------- @@ -56,5 +52,5 @@ The only way to eliminate thread private data at an index prior to the thread's termination is to call :ref:`PR_SetThreadPrivate` with a ``NULL`` argument. This causes the index's destructor function to be called, and afterwards assigns a ``NULL`` in the table. A client must not delete the -referant object of a non-``NULL`` private data without first eliminating +referent object of a non-``NULL`` private data without first eliminating it from the table. diff --git a/docs/nspr/reference/pr_shutdown.rst b/docs/nspr/reference/pr_shutdown.rst index 522ba659a2c6..d15489545c3a 100644 --- a/docs/nspr/reference/pr_shutdown.rst +++ b/docs/nspr/reference/pr_shutdown.rst @@ -3,7 +3,6 @@ PR_Shutdown Shuts down part of a full-duplex connection on a specified socket. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRFileDesc *fd, PRShutdownHow how); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -34,7 +32,6 @@ The function has the following parameters: - :ref:`PR_SHUTDOWN_BOTH`. Further sends and receives will be disallowed. -.. _Returns: Returns ~~~~~~~ @@ -45,7 +42,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. Further information can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_shutdownthreadpool.rst b/docs/nspr/reference/pr_shutdownthreadpool.rst index 0ef4d57dc34f..4ea193b1a7d9 100644 --- a/docs/nspr/reference/pr_shutdownthreadpool.rst +++ b/docs/nspr/reference/pr_shutdownthreadpool.rst @@ -3,7 +3,6 @@ PR_ShutdownThreadPool Notifies all threads in a thread pool to terminate. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax NSPR_API(PRStatus) PR_ShutdownThreadPool( PRThreadPool *tpool ); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: A pointer to a :ref:`PRThreadPool` structure previously created by a call to :ref:`PR_CreateThreadPool`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_sleep.rst b/docs/nspr/reference/pr_sleep.rst index 89e29cb47de8..52fc2a906cd0 100644 --- a/docs/nspr/reference/pr_sleep.rst +++ b/docs/nspr/reference/pr_sleep.rst @@ -3,7 +3,6 @@ PR_Sleep Causes the current thread to yield for a specified amount of time. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_Sleep(PRIntervalTime ticks); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ Parameter The number of ticks you want the thread to sleep for (see :ref:`PRIntervalTime`). -.. _Returns: Returns ~~~~~~~ @@ -34,7 +31,6 @@ Calling :ref:`PR_Sleep` with a parameter equivalent to ``PR_INTERVAL_NO_TIMEOUT`` is an error and results in a ``PR_FAILURE`` error. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_static_assert.rst b/docs/nspr/reference/pr_static_assert.rst index 7c50d79a2fb6..91a6b24e8e4d 100644 --- a/docs/nspr/reference/pr_static_assert.rst +++ b/docs/nspr/reference/pr_static_assert.rst @@ -4,7 +4,6 @@ PR_STATIC_ASSERT Prevents code from compiling when an expression has the value ``FALSE`` at compile time. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PR_STATIC_ASSERT ( expression ); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,14 +26,12 @@ expression will cause a compiler error; see :ref:`PR_ASSERT` for a runtime alternative. -.. _Returns: Returns ~~~~~~~ Nothing -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_stringtonetaddr.rst b/docs/nspr/reference/pr_stringtonetaddr.rst index c208db957a04..cf6c9c6eb43c 100644 --- a/docs/nspr/reference/pr_stringtonetaddr.rst +++ b/docs/nspr/reference/pr_stringtonetaddr.rst @@ -3,7 +3,6 @@ PR_StringToNetAddr Converts a character string to a network address. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax const char *string, PRNetAddr *addr); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has the following parameters: ``addr`` On output, the equivalent network address. -.. _Returns: Returns ~~~~~~~ @@ -39,7 +36,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. You can retrieve the reason for the failure by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_strtod.rst b/docs/nspr/reference/pr_strtod.rst index f62c8f24dfe1..3318e0736812 100644 --- a/docs/nspr/reference/pr_strtod.rst +++ b/docs/nspr/reference/pr_strtod.rst @@ -4,7 +4,6 @@ PR_strtod Converts the prefix of a decimal string to the nearest double-precision floating point number. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRFloat64 PR_strtod(const char *s00, char **se); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has these parameters: A pointer that, if not ``NULL``, will be assigned the address of the last character scanned in the input string. -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ The result of the conversion is a ``PRFloat64`` value equivalent to the input string. If the parameter ``se`` is not ``NULL`` the location it references is also set. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_sync.rst b/docs/nspr/reference/pr_sync.rst index abf390ba49d2..917991963c32 100644 --- a/docs/nspr/reference/pr_sync.rst +++ b/docs/nspr/reference/pr_sync.rst @@ -4,7 +4,6 @@ PR_Sync Synchronizes any buffered data for a file descriptor to its backing device (disk). -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRStatus PR_Sync(PRFileDesc *fd); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,7 +23,6 @@ The function has the following parameter: ``fd`` Pointer to a :ref:`PRFileDesc` object representing a file. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ The function returns one of the following values: - On successful completion, ``PR_SUCCESS``. - If the function fails, ``PR_FAILURE``. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_tickspersecond.rst b/docs/nspr/reference/pr_tickspersecond.rst index a79ee6819a21..ff9aec598eeb 100644 --- a/docs/nspr/reference/pr_tickspersecond.rst +++ b/docs/nspr/reference/pr_tickspersecond.rst @@ -4,7 +4,6 @@ PR_TicksPerSecond Returns the number of ticks per second currently used to determine the value of :ref:`PRIntervalTime`. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax PRUint32 PR_TicksPerSecond(void); -.. _Returns: Returns ~~~~~~~ @@ -24,7 +22,6 @@ An integer between 1000 and 100000 indicating the number of ticks per second counted by :ref:`PRIntervalTime` on the current platform. This value is platform-dependent and does not change after NSPR is initialized. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_transmitfile.rst b/docs/nspr/reference/pr_transmitfile.rst index 94fad5ed5eaf..e8c8d11f4601 100644 --- a/docs/nspr/reference/pr_transmitfile.rst +++ b/docs/nspr/reference/pr_transmitfile.rst @@ -3,7 +3,6 @@ PR_TransmitFile Sends a complete file across a connected socket. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax PRTransmitFileFlags flags, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -48,7 +46,6 @@ The function has the following parameters: ``timeout`` Time limit for completion of the transmit operation. -.. _Returns: Returns ~~~~~~~ @@ -59,7 +56,6 @@ Returns the file, the ``PR_TRANSMITFILE_CLOSE_SOCKET`` flag is ignored. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_unblockclockinterrupts.rst b/docs/nspr/reference/pr_unblockclockinterrupts.rst index 6c61b22497c7..b6c53c4535b0 100644 --- a/docs/nspr/reference/pr_unblockclockinterrupts.rst +++ b/docs/nspr/reference/pr_unblockclockinterrupts.rst @@ -3,7 +3,6 @@ PR_UnblockClockInterrupts Unblocks the timer signal used for preemptive scheduling. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_unloadlibrary.rst b/docs/nspr/reference/pr_unloadlibrary.rst index 35b157f72b28..a69af09f2f9e 100644 --- a/docs/nspr/reference/pr_unloadlibrary.rst +++ b/docs/nspr/reference/pr_unloadlibrary.rst @@ -3,7 +3,6 @@ PR_UnloadLibrary Unloads a library loaded with :ref:`PR_LoadLibrary`. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax PRStatus PR_UnloadLibrary(PRLibrary *lib); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -24,7 +22,6 @@ The function has this parameter: ``lib`` A reference previously returned from :ref:`PR_LoadLibrary`. -.. _Returns: Returns ~~~~~~~ @@ -35,7 +32,6 @@ The function returns one of the following values: - If unsuccessful, ``PR_FAILURE``. Use :ref:`PR_GetError` to find the reason for the failure. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_unlock.rst b/docs/nspr/reference/pr_unlock.rst index 83df81b6da5b..b57cdf18acf8 100644 --- a/docs/nspr/reference/pr_unlock.rst +++ b/docs/nspr/reference/pr_unlock.rst @@ -7,7 +7,6 @@ an error. Attempting to release a lock that was locked by a different thread causes undefined behavior. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRStatus PR_Unlock(PRLock *lock); -.. _Parameter: Parameter ~~~~~~~~~ @@ -28,7 +26,6 @@ Parameter ``lock`` A pointer to a lock object to be released. -.. _Returns: Returns ~~~~~~~ @@ -39,7 +36,6 @@ The function returns one of the following values: - If unsuccessful (for example, if the caller does not own the lock), ``PR_FAILURE``. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_unmap.rst b/docs/nspr/reference/pr_unmap.rst index 746175a6ad0b..b7d3b4c8ab63 100644 --- a/docs/nspr/reference/pr_unmap.rst +++ b/docs/nspr/reference/pr_unmap.rst @@ -3,7 +3,6 @@ PR_MemUnmap Unmap a memory region that is backed by a memory-mapped file. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax void *addr, PRUint32 len); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -28,7 +26,6 @@ The function has the following parameters: ``len`` The length, in bytes, of the memory region. -.. _Returns: Returns ~~~~~~~ @@ -39,7 +36,6 @@ The function returns one of the following values: - If the memory region is not successfully unmapped, ``PR_FAILURE``. The error code can be retrieved via :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_usec_per_msec.rst b/docs/nspr/reference/pr_usec_per_msec.rst index baf69adba675..ffcef2a38f22 100644 --- a/docs/nspr/reference/pr_usec_per_msec.rst +++ b/docs/nspr/reference/pr_usec_per_msec.rst @@ -5,7 +5,6 @@ A convenience macro to improve code readability as well as to avoid mistakes in counting the number of zeros; represents the number of microseconds in a millisecond. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_usec_per_sec.rst b/docs/nspr/reference/pr_usec_per_sec.rst index e68f4f45db7c..c47a1435905f 100644 --- a/docs/nspr/reference/pr_usec_per_sec.rst +++ b/docs/nspr/reference/pr_usec_per_sec.rst @@ -5,7 +5,6 @@ A convenience macro to improve code readability as well as to avoid mistakes in counting the number of zeros; represents the number of microseconds in a second. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pr_version.rst b/docs/nspr/reference/pr_version.rst index 4131312dea48..26881935d7c8 100644 --- a/docs/nspr/reference/pr_version.rst +++ b/docs/nspr/reference/pr_version.rst @@ -1,7 +1,6 @@ PR_VERSION ========== -.. _Syntax: Syntax ------ @@ -12,7 +11,6 @@ Syntax #define PR_VERSION "2.1 yyyymmdd" -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_versioncheck.rst b/docs/nspr/reference/pr_versioncheck.rst index 1455e5f27438..6b4b131ba8b7 100644 --- a/docs/nspr/reference/pr_versioncheck.rst +++ b/docs/nspr/reference/pr_versioncheck.rst @@ -5,7 +5,6 @@ Compares the version of NSPR assumed by the caller (the imported version) with the version being offered by the runtime (the exported version). -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRBool PR_VersionCheck(const char *importedVersion); -.. _Parameter: Parameter ~~~~~~~~~ @@ -26,7 +24,6 @@ Parameter ``importedVersion`` The version of the shared library being imported. -.. _Returns: Returns ~~~~~~~ @@ -37,7 +34,6 @@ The function returns one of the following values: by the caller, ``PR_TRUE``. - If the versions are not compatible, ``PR_FALSE``. -.. _Description: Description ----------- @@ -47,7 +43,6 @@ imported (``importedVersion``) is compatible with the running version of the shared library. This is a string comparison of sorts, though the details of the comparison will vary over time. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/pr_wait.rst b/docs/nspr/reference/pr_wait.rst index 9c2800024c31..da8c3e3b22b4 100644 --- a/docs/nspr/reference/pr_wait.rst +++ b/docs/nspr/reference/pr_wait.rst @@ -3,7 +3,6 @@ PR_Wait Waits for an application-defined state of the monitored data to exist. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRMonitor *mon, PRIntervalTime ticks); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -32,7 +30,6 @@ The function has the following parameter: willing to wait for an explicit notification before being rescheduled. -.. _Returns: Returns ~~~~~~~ @@ -42,11 +39,10 @@ The function returns one of the following values: - :ref:`PR_SUCCESS`` means the thread is being resumed from the ``PR_Wait` call either because it was explicitly notified or because the time specified by the parameter ``ticks`` has expired. - - :ref:`PR_FAILURE`` means ``PR_Wait` encountered a system error (such as + - :ref:`PR_FAILURE` means ``PR_Wait`` encountered a system error (such as an invalid monitor reference) or the thread was interrupted by another thread. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_waitcondvar.rst b/docs/nspr/reference/pr_waitcondvar.rst index 27b9a47413cb..648d869fb24f 100644 --- a/docs/nspr/reference/pr_waitcondvar.rst +++ b/docs/nspr/reference/pr_waitcondvar.rst @@ -3,7 +3,6 @@ PR_WaitCondVar Waits on a condition. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax PRCondVar *cvar, PRIntervalTime timeout); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -32,7 +30,6 @@ Parameters the lock, possibly causing a rescheduling within the runtime, then immediately attempt to reacquire the lock and resume. -.. _Returns: Returns ~~~~~~~ @@ -45,7 +42,6 @@ The function returns one of the following values: with :ref:`PR_Interrupt`), ``PR_FAILURE``. The details can be determined with :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_waitforpollableevent.rst b/docs/nspr/reference/pr_waitforpollableevent.rst index b0ee33d9f262..de5d56b46d0b 100644 --- a/docs/nspr/reference/pr_waitforpollableevent.rst +++ b/docs/nspr/reference/pr_waitforpollableevent.rst @@ -4,7 +4,6 @@ PR_WaitForPollableEvent Blocks the calling thread until the pollable event is set, and then atomically unsetting the event before returning. -.. _Syntax: Syntax ------ @@ -13,7 +12,6 @@ Syntax NSPR_API(PRStatus) PR_WaitForPollableEvent(PRFileDesc *event); -.. _Parameter: Parameter ~~~~~~~~~ @@ -24,7 +22,6 @@ The function has the following parameter: Pointer to a :ref:`PRFileDesc` structure previously created via a call to :ref:`PR_NewPollableEvent`. -.. _Returns: Returns ~~~~~~~ diff --git a/docs/nspr/reference/pr_waitsemaphore.rst b/docs/nspr/reference/pr_waitsemaphore.rst index 980fbf14b6db..38e785bcedd4 100644 --- a/docs/nspr/reference/pr_waitsemaphore.rst +++ b/docs/nspr/reference/pr_waitsemaphore.rst @@ -3,7 +3,6 @@ PR_WaitSemaphore Returns the value of the environment variable. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax NSPR_API(PRStatus) PR_WaitSemaphore(PRSem *sem); -.. _Parameter: Parameter ~~~~~~~~~ @@ -25,14 +23,12 @@ The function has the following parameter: A pointer to a ``PRSem`` structure returned from a call to :ref:`PR_OpenSemaphore`. -.. _Returns: Returns ~~~~~~~ :ref:`PRStatus` -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_write.rst b/docs/nspr/reference/pr_write.rst index 027eb1c7ef46..ecdc43b2ef2d 100644 --- a/docs/nspr/reference/pr_write.rst +++ b/docs/nspr/reference/pr_write.rst @@ -3,7 +3,6 @@ PR_Write Writes a buffer of data to a file or socket. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax const void *buf, PRInt32 amount); -.. _Parameters: Parameters ~~~~~~~~~~ @@ -31,7 +29,6 @@ The function has the following parameters: ``amount`` The amount of data, in bytes, to be written from the buffer. -.. _Returns: Returns ~~~~~~~ @@ -42,7 +39,6 @@ One of the following values: - The value -1 indicates that the operation failed. The reason for the failure is obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pr_writev.rst b/docs/nspr/reference/pr_writev.rst index 3e156d4fc51c..b0e0f2949c89 100644 --- a/docs/nspr/reference/pr_writev.rst +++ b/docs/nspr/reference/pr_writev.rst @@ -3,7 +3,6 @@ PR_Writev Writes data to a socket from multiple buffers. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax #define PR_MAX_IOVECTOR_SIZE 16 -.. _Parameters: Parameters ~~~~~~~~~~ @@ -41,7 +39,6 @@ The function has the following parameters: A value of type :ref:`PRIntervalTime` describing the time limit for completion of the entire write operation. -.. _Returns: Returns ~~~~~~~ @@ -52,7 +49,6 @@ One of the following values: - The value -1 indicates that the operation failed. The reason for the failure can be obtained by calling :ref:`PR_GetError`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prbool.rst b/docs/nspr/reference/prbool.rst index 778f18a70332..851c776ad605 100644 --- a/docs/nspr/reference/prbool.rst +++ b/docs/nspr/reference/prbool.rst @@ -3,7 +3,6 @@ PRBool Boolean value. -.. _Syntax: Syntax ~~~~~~ @@ -14,7 +13,6 @@ Syntax typedef enum { PR_FALSE = 0, PR_TRUE = 1 } PRBool; -.. _Description: Description ~~~~~~~~~~~ @@ -25,5 +23,5 @@ C++ ``bool`` instead. Otherwise, use :ref:`PRBool` for variables and parameter types. Use ``PR_FALSE`` and ``PR_TRUE`` for clarity of target type in assignments and actual arguments. Use ``if (bool)``, ``while (!bool)``, -``(bool) ? x : y``, and so on to test Boolean values, just as you would +``(bool) ? x : y``, and so on to test Boolean values, just as you would C ``int``-valued conditions. diff --git a/docs/nspr/reference/prcalloncefn.rst b/docs/nspr/reference/prcalloncefn.rst index 25b7ae84890b..b584d0e3d827 100644 --- a/docs/nspr/reference/prcalloncefn.rst +++ b/docs/nspr/reference/prcalloncefn.rst @@ -3,7 +3,6 @@ PRCallOnceFN Defines the signature of the function a client must implement. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef PRStatus (PR_CALLBACK *PRCallOnceFN)(void); -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prcalloncetype.rst b/docs/nspr/reference/prcalloncetype.rst index 1c5a46337dc2..d0bcea57cd51 100644 --- a/docs/nspr/reference/prcalloncetype.rst +++ b/docs/nspr/reference/prcalloncetype.rst @@ -3,7 +3,6 @@ PRCallOnceType Structure for tracking initialization. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PRStatus status; } PRCallOnceType; -.. _Fields: Fields ~~~~~~ @@ -34,7 +32,6 @@ The structure has these fields: ``status`` An indication of the outcome of the initialization process. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prclist.rst b/docs/nspr/reference/prclist.rst index 3e74d0559f17..ed272e53d1aa 100644 --- a/docs/nspr/reference/prclist.rst +++ b/docs/nspr/reference/prclist.rst @@ -3,7 +3,6 @@ PRCList A circular linked list. -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PRCList *previous; }; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prcondvar.rst b/docs/nspr/reference/prcondvar.rst index 355a98aedad9..e8f39223b6ea 100644 --- a/docs/nspr/reference/prcondvar.rst +++ b/docs/nspr/reference/prcondvar.rst @@ -3,7 +3,6 @@ PRCondVar Structure for a condition variable. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef struct PRCondVar PRCondVar; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prdescidentity.rst b/docs/nspr/reference/prdescidentity.rst index 1e40a1207424..04643a33b449 100644 --- a/docs/nspr/reference/prdescidentity.rst +++ b/docs/nspr/reference/prdescidentity.rst @@ -3,7 +3,6 @@ PRDescIdentity The identity of a file descriptor's layer. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef PRUintn PRDescIdentity; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prdir.rst b/docs/nspr/reference/prdir.rst index 485200714417..8eee03027045 100644 --- a/docs/nspr/reference/prdir.rst +++ b/docs/nspr/reference/prdir.rst @@ -4,7 +4,6 @@ PRDir Directory structure used with `Directory I/O Functions `__. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax typedef struct PRDir PRDir; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prerrorcode.rst b/docs/nspr/reference/prerrorcode.rst index 832561e83894..398f6e371c72 100644 --- a/docs/nspr/reference/prerrorcode.rst +++ b/docs/nspr/reference/prerrorcode.rst @@ -5,7 +5,6 @@ PRErrorCode Type for error codes that can be retrieved with :ref:`PR_GetError`. You can also set your own errors using :ref:`PR_SetError`. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax typedef PRInt32 PRErrorCode -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prexplodedtime.rst b/docs/nspr/reference/prexplodedtime.rst index eb75ab524eb1..e8d0de758b5e 100644 --- a/docs/nspr/reference/prexplodedtime.rst +++ b/docs/nspr/reference/prexplodedtime.rst @@ -3,7 +3,6 @@ PRExplodedTime A clock/calendar representation of times. -.. _Syntax: Syntax ------ @@ -25,7 +24,6 @@ Syntax PRTimeParameters tm_params; } PRExplodedTime; -.. _Description: Description ----------- @@ -52,7 +50,7 @@ The essential members of :ref:`PRExplodedTime` are: values 60 and 61 are for accommodating up to two leap seconds. - :ref:`tm_usec`: number of microseconds past tm_sec. The range is [0, 999999]. - - :ref:`tm_params``: a ``PRTimeParameters` structure representing the + - :ref:`tm_params`: a `PRTimeParameters` structure representing the local time zone information. The nonessential members of :ref:`PRExplodedTime` are: diff --git a/docs/nspr/reference/prfiledesc.rst b/docs/nspr/reference/prfiledesc.rst index 634f2d02b20a..83606d60d5f5 100644 --- a/docs/nspr/reference/prfiledesc.rst +++ b/docs/nspr/reference/prfiledesc.rst @@ -5,7 +5,6 @@ A file descriptor used to represent any open file, such as a normal file, an end point of a pipe, or a socket (end point of network communication). -.. _Syntax: Syntax ------ @@ -24,7 +23,6 @@ Syntax typedef struct PRFileDesc PRFileDesc; -.. _Parameters: Parameters ~~~~~~~~~~ @@ -42,7 +40,6 @@ Parameters ``identity`` Identity of this particular layer. See :ref:`PRDescIdentity`. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prfileinfo.rst b/docs/nspr/reference/prfileinfo.rst index ededc8210539..53d27755d242 100644 --- a/docs/nspr/reference/prfileinfo.rst +++ b/docs/nspr/reference/prfileinfo.rst @@ -4,7 +4,6 @@ PRFileInfo File information structure used with :ref:`PR_GetFileInfo` and :ref:`PR_GetOpenFileInfo`. -.. _Syntax: Syntax ~~~~~~ @@ -22,9 +21,8 @@ Syntax typedef struct PRFileInfo PRFileInfo; -  + -.. _Fields: Fields ~~~~~~ @@ -42,7 +40,6 @@ The structure has the following fields: Last modification time per definition of :ref:`PRTime`. See `prtime.h `__. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prfileinfo64.rst b/docs/nspr/reference/prfileinfo64.rst index 923e1442fc13..40b198fcec85 100644 --- a/docs/nspr/reference/prfileinfo64.rst +++ b/docs/nspr/reference/prfileinfo64.rst @@ -4,7 +4,6 @@ PRFileInfo64 File information structure used with :ref:`PR_GetFileInfo64` and :ref:`PR_GetOpenFileInfo64`. -.. _Syntax: Syntax ------ @@ -22,7 +21,6 @@ Syntax typedef struct PRFileInfo64 PRFileInfo64; -.. _Fields: Fields ~~~~~~ @@ -40,7 +38,6 @@ The structure has the following fields: Last modification time per definition of :ref:`PRTime`. See `prtime.h `__. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prfilemap.rst b/docs/nspr/reference/prfilemap.rst index dff52768a47c..be645d647ede 100644 --- a/docs/nspr/reference/prfilemap.rst +++ b/docs/nspr/reference/prfilemap.rst @@ -4,7 +4,6 @@ PRFileMap Type returned by :ref:`PR_CreateFileMap` and passed to :ref:`PR_MemMap` and :ref:`PR_CloseFileMap`. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax typedef struct PRFileMap PRFileMap; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prfileprivate.rst b/docs/nspr/reference/prfileprivate.rst index e7d91dbe17dc..c77f35b75f59 100644 --- a/docs/nspr/reference/prfileprivate.rst +++ b/docs/nspr/reference/prfileprivate.rst @@ -4,7 +4,6 @@ PRFilePrivate Layer-dependent implementation data. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax typedef struct PRFilePrivate PRFilePrivate; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prfiletype.rst b/docs/nspr/reference/prfiletype.rst index 411b01063da0..fbc9cdfac673 100644 --- a/docs/nspr/reference/prfiletype.rst +++ b/docs/nspr/reference/prfiletype.rst @@ -5,7 +5,6 @@ PRFileType Type for enumerators used in the type field of the :ref:`PRFileInfo` and :ref:`PRFileInfo64` structures. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax PR_FILE_OTHER = 3 } PRFileType; -.. _Enumerators: Enumerators ~~~~~~~~~~~ diff --git a/docs/nspr/reference/prfloat64.rst b/docs/nspr/reference/prfloat64.rst index e660f189f515..42e3a58cb524 100644 --- a/docs/nspr/reference/prfloat64.rst +++ b/docs/nspr/reference/prfloat64.rst @@ -4,7 +4,6 @@ PRFloat64 The NSPR floating-point type is always 64 bits. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prhostent.rst b/docs/nspr/reference/prhostent.rst index b712e0f1b6f6..36a4bb5cc557 100644 --- a/docs/nspr/reference/prhostent.rst +++ b/docs/nspr/reference/prhostent.rst @@ -6,7 +6,6 @@ output from :ref:`PR_GetHostByName` and :ref:`PR_GetHostByAddr` and passed to :ref:`PR_EnumerateHostEnt`. Clients should avoid directly accessing any of the structure's fields. -.. _Syntax: Syntax ------ @@ -28,7 +27,6 @@ Syntax char **h_addr_list; } PRHostEnt; -.. _Fields: Fields ~~~~~~ @@ -51,7 +49,6 @@ The structure has the following fields: Pointer to a pointer to a list of addresses from name server (in network byte order). The list is terminated with a ``NULL`` entry. -.. _Description: Description ----------- @@ -64,8 +61,6 @@ Use the network address functions to manipulate the :ref:`PRHostEnt` structure. To make the transition to IP version 6 easier, it's best to treat :ref:`PRHostEnt` as an opaque structure. -.. _Note: - Note ---- diff --git a/docs/nspr/reference/print16.rst b/docs/nspr/reference/print16.rst index 8dacc648d987..8701a0ea5d8d 100644 --- a/docs/nspr/reference/print16.rst +++ b/docs/nspr/reference/print16.rst @@ -3,7 +3,6 @@ PRInt16 Guaranteed to be a signed 16-bit integer on all platforms. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/print32.rst b/docs/nspr/reference/print32.rst index 0b669d34b43d..829d66d0abd6 100644 --- a/docs/nspr/reference/print32.rst +++ b/docs/nspr/reference/print32.rst @@ -3,7 +3,6 @@ PRInt32 Guaranteed to be a signed 32-bit integer on all platforms. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedefdefinition PRInt32; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/print64.rst b/docs/nspr/reference/print64.rst index e5d795b10d07..409494cb69c6 100644 --- a/docs/nspr/reference/print64.rst +++ b/docs/nspr/reference/print64.rst @@ -3,7 +3,6 @@ PRInt64 Guaranteed to be a signed 64-bit integer on all platforms. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef definition PRInt64; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/print8.rst b/docs/nspr/reference/print8.rst index 82c1ca74f80b..ca19521c68e3 100644 --- a/docs/nspr/reference/print8.rst +++ b/docs/nspr/reference/print8.rst @@ -3,7 +3,6 @@ PRInt8 Guaranteed to be a signed 8-bit integer on all platforms. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/printervaltime.rst b/docs/nspr/reference/printervaltime.rst index 91d5ba7b19d8..c60978353628 100644 --- a/docs/nspr/reference/printervaltime.rst +++ b/docs/nspr/reference/printervaltime.rst @@ -4,7 +4,6 @@ PRIntervalTime A platform-dependent type that represents a monotonically increasing integer--the NSPR runtime clock. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax #define PR_INTERVAL_NO_WAIT 0UL #define PR_INTERVAL_NO_TIMEOUT 0xffffffffUL -.. _Description: Description ----------- diff --git a/docs/nspr/reference/printn.rst b/docs/nspr/reference/printn.rst index 4c1c578a77de..b78eb045d9bd 100644 --- a/docs/nspr/reference/printn.rst +++ b/docs/nspr/reference/printn.rst @@ -6,7 +6,6 @@ guaranteed to be at least 16 bits, though various architectures may define it to be wider (for example, 32 or even 64 bits). This types is never valid for fields of a structure. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/priomethods.rst b/docs/nspr/reference/priomethods.rst index 826145d1daee..2b2b15f57ca5 100644 --- a/docs/nspr/reference/priomethods.rst +++ b/docs/nspr/reference/priomethods.rst @@ -3,7 +3,6 @@ PRIOMethods The table of I/O methods used in a file descriptor. -.. _Syntax: Syntax ------ @@ -45,7 +44,6 @@ Syntax typedef struct PRIOMethods PRIOMethods; -.. _Parameters: Parameters ~~~~~~~~~~ @@ -108,7 +106,6 @@ Parameters ``setsockopt`` Set value of specified socket option. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pripv6addr.rst b/docs/nspr/reference/pripv6addr.rst index 863ae2bc5732..2c47602e40c7 100644 --- a/docs/nspr/reference/pripv6addr.rst +++ b/docs/nspr/reference/pripv6addr.rst @@ -3,7 +3,6 @@ PRIPv6Addr Type used in the ``ipv6.ip`` field of the :ref:`PRNetAddr` structure. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax typedef struct in6_addr PRIPv6Addr; #endif /* defined(_PR_INET6) */ -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prjob.rst b/docs/nspr/reference/prjob.rst index 46df3a3f9232..7407f43cf148 100644 --- a/docs/nspr/reference/prjob.rst +++ b/docs/nspr/reference/prjob.rst @@ -1,7 +1,6 @@ PRJob ===== -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prjobfn.rst b/docs/nspr/reference/prjobfn.rst index 4c0ba987ba10..93aa0a81e4f8 100644 --- a/docs/nspr/reference/prjobfn.rst +++ b/docs/nspr/reference/prjobfn.rst @@ -1,7 +1,6 @@ PRJobFn ======= -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prjobiodesc.rst b/docs/nspr/reference/prjobiodesc.rst index a137013120f1..b3e3cadc61c2 100644 --- a/docs/nspr/reference/prjobiodesc.rst +++ b/docs/nspr/reference/prjobiodesc.rst @@ -1,7 +1,6 @@ PRJobIoDesc =========== -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prlibrary.rst b/docs/nspr/reference/prlibrary.rst index 2c9dfaa0a203..d730cccb623c 100644 --- a/docs/nspr/reference/prlibrary.rst +++ b/docs/nspr/reference/prlibrary.rst @@ -3,7 +3,6 @@ PRLibrary An opaque structure identifying a library. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef struct PRLibrary PRLibrary; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prlinger.rst b/docs/nspr/reference/prlinger.rst index 27e6a3166907..7270b71f0bcb 100644 --- a/docs/nspr/reference/prlinger.rst +++ b/docs/nspr/reference/prlinger.rst @@ -5,7 +5,6 @@ Structure used with the ``PR_SockOpt_Linger`` socket option to specify the time interval (in :ref:`PRIntervalTime` units) to linger on closing a socket if any data remain in the socket send buffer. -.. _Syntax: Syntax ~~~~~~ @@ -19,7 +18,6 @@ Syntax PRIntervalTime linger; } PRLinger; -.. _Fields: Fields ~~~~~~ @@ -35,7 +33,6 @@ The structure has the following fields: Time (in :ref:`PRIntervalTime` units) to linger before closing if any data remain in the socket send buffer. -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/prlock.rst b/docs/nspr/reference/prlock.rst index bd5753f975df..9e37aceea303 100644 --- a/docs/nspr/reference/prlock.rst +++ b/docs/nspr/reference/prlock.rst @@ -3,7 +3,6 @@ PRLock A mutual exclusion lock. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef struct PRLock PRLock; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prlogmoduleinfo.rst b/docs/nspr/reference/prlogmoduleinfo.rst index 88779ad90586..d0fe3314116c 100644 --- a/docs/nspr/reference/prlogmoduleinfo.rst +++ b/docs/nspr/reference/prlogmoduleinfo.rst @@ -6,9 +6,8 @@ The ``PRLogModuleInfo`` structure controls logging from within your application. To log your program's activity, create a ``PRLogModuleInfo`` structure using `:ref:`PR_NewLogModule` `__ -.  +. -.. _Syntax: Syntax ------ @@ -18,7 +17,7 @@ Syntax #include typedef struct PRLogModuleInfo { -    const char *name; -    PRLogModuleLevel level; -    struct PRLogModuleInfo *next; + const char *name; + PRLogModuleLevel level; + struct PRLogModuleInfo *next; } PRLogModuleInfo; diff --git a/docs/nspr/reference/prlogmodulelevel.rst b/docs/nspr/reference/prlogmodulelevel.rst index 6a5a05d816c7..d9ed3f78cab3 100644 --- a/docs/nspr/reference/prlogmodulelevel.rst +++ b/docs/nspr/reference/prlogmodulelevel.rst @@ -4,7 +4,6 @@ PRLogModuleLevel The enumerated type :ref:`PRLogModuleLevel` defines levels of logging available to application programs. -.. _Syntax: Syntax ------ @@ -14,14 +13,14 @@ Syntax #include typedef enum PRLogModuleLevel { -    PR_LOG_NONE = 0, -    PR_LOG_ALWAYS = 1, -    PR_LOG_ERROR = 2, -    PR_LOG_WARNING = 3, -    PR_LOG_DEBUG = 4, + PR_LOG_NONE = 0, + PR_LOG_ALWAYS = 1, + PR_LOG_ERROR = 2, + PR_LOG_WARNING = 3, + PR_LOG_DEBUG = 4, PR_LOG_NOTICE = PR_LOG_DEBUG, -    PR_LOG_WARN = PR_LOG_WARNING, -    PR_LOG_MIN = PR_LOG_DEBUG, -    PR_LOG_MAX = PR_LOG_DEBUG + PR_LOG_WARN = PR_LOG_WARNING, + PR_LOG_MIN = PR_LOG_DEBUG, + PR_LOG_MAX = PR_LOG_DEBUG } PRLogModuleLevel; diff --git a/docs/nspr/reference/prmcastrequest.rst b/docs/nspr/reference/prmcastrequest.rst index 1d17357ba857..54bb16c97f1e 100644 --- a/docs/nspr/reference/prmcastrequest.rst +++ b/docs/nspr/reference/prmcastrequest.rst @@ -5,7 +5,6 @@ Structure used to specify values for the ``PR_SockOpt_AddMember`` and ``PR_SockOpt_DropMember`` socket options that define a request to join or leave a multicast group. -.. _Syntax: Syntax ------ @@ -21,7 +20,6 @@ Syntax typedef struct PRMcastRequest PRMcastRequest; -.. _Fields: Fields ~~~~~~ @@ -33,7 +31,6 @@ The structure has the following fields: ``ifaddr`` Local IP address of interface. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prmonitor.rst b/docs/nspr/reference/prmonitor.rst index f00a2fa01c05..ea3edc322c17 100644 --- a/docs/nspr/reference/prmonitor.rst +++ b/docs/nspr/reference/prmonitor.rst @@ -4,7 +4,6 @@ PRMonitor An opaque structure managed entirely by the client. Clients create them when needed and must destroy them when no longer needed. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prnetaddr.rst b/docs/nspr/reference/prnetaddr.rst index 03dfb90d1aae..576c76caff10 100644 --- a/docs/nspr/reference/prnetaddr.rst +++ b/docs/nspr/reference/prnetaddr.rst @@ -5,7 +5,6 @@ Type used with `Socket Manipulation Functions `__ to specify a network address. -.. _Syntax: Syntax ------ @@ -37,7 +36,6 @@ Syntax typedef union PRNetAddr PRNetAddr; -.. _Fields: Fields ~~~~~~ @@ -60,7 +58,6 @@ The structure has the following fields: ``flowinfo`` Routing information. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/process_management_and_interprocess_communication.rst b/docs/nspr/reference/process_management_and_interprocess_communication.rst index 7933e1364ae2..8b00ee78e056 100644 --- a/docs/nspr/reference/process_management_and_interprocess_communication.rst +++ b/docs/nspr/reference/process_management_and_interprocess_communication.rst @@ -21,7 +21,7 @@ Process Management Types and Constants The types defined for process management are: - - :ref:`PRProcess`  + - :ref:`PRProcess` - :ref:`PRProcessAttr` .. _Process_Management_Functions: @@ -44,11 +44,11 @@ Setting the Attributes of a New Process The functions that create and manipulate attribute sets of new processes are: - - :ref:`PR_NewProcessAttr`  - - :ref:`PR_ResetProcessAttr`  - - :ref:`PR_DestroyProcessAttr`  - - :ref:`PR_ProcessAttrSetStdioRedirect`  - - :ref:`PR_ProcessAttrSetCurrentDirectory`  + - :ref:`PR_NewProcessAttr` + - :ref:`PR_ResetProcessAttr` + - :ref:`PR_DestroyProcessAttr` + - :ref:`PR_ProcessAttrSetStdioRedirect` + - :ref:`PR_ProcessAttrSetCurrentDirectory` - :ref:`PR_ProcessAttrSetInheritableFD` .. _Creating_and_Managing_Processes: @@ -58,7 +58,7 @@ Creating and Managing Processes The functions that create and manage processes are: - - :ref:`PR_CreateProcess`  - - :ref:`PR_DetachProcess`  - - :ref:`PR_WaitProcess`  + - :ref:`PR_CreateProcess` + - :ref:`PR_DetachProcess` + - :ref:`PR_WaitProcess` - :ref:`PR_KillProcess` diff --git a/docs/nspr/reference/prpackedbool.rst b/docs/nspr/reference/prpackedbool.rst index 776c008c6481..70c482f06e12 100644 --- a/docs/nspr/reference/prpackedbool.rst +++ b/docs/nspr/reference/prpackedbool.rst @@ -3,7 +3,6 @@ PRPackedBool Packed Boolean value. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef PRUint8 PRPackedBool; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prprimordialfn.rst b/docs/nspr/reference/prprimordialfn.rst index b103517c265e..7c91b76214ee 100644 --- a/docs/nspr/reference/prprimordialfn.rst +++ b/docs/nspr/reference/prprimordialfn.rst @@ -4,7 +4,6 @@ PRPrimordialFn The type for the root function used by :ref:`PR_Initialize` is specified as follows: -.. _Syntax: Syntax ------ @@ -13,7 +12,6 @@ Syntax typedef PRIntn (PR_CALLBACK *PRPrimordialFn)(PRIntn argc, char **argv); -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/prprocess.rst b/docs/nspr/reference/prprocess.rst index 7824737a9800..b17db0b3da7f 100644 --- a/docs/nspr/reference/prprocess.rst +++ b/docs/nspr/reference/prprocess.rst @@ -3,7 +3,6 @@ PRProcess Represents a process. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef struct PRProcess PRProcess; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prprocessattr.rst b/docs/nspr/reference/prprocessattr.rst index 843999913465..65e48e120121 100644 --- a/docs/nspr/reference/prprocessattr.rst +++ b/docs/nspr/reference/prprocessattr.rst @@ -3,7 +3,6 @@ PRProcessAttr Represents the attributes of a new process. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef struct PRProcessAttr PRProcessAttr; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prprotoent.rst b/docs/nspr/reference/prprotoent.rst index 90b673c05a00..584346414bf2 100644 --- a/docs/nspr/reference/prprotoent.rst +++ b/docs/nspr/reference/prprotoent.rst @@ -4,7 +4,6 @@ PRProtoEnt Protocol entry returned by :ref:`PR_GetProtoByName` and :ref:`PR_GetProtoByNumber`. -.. _Syntax: Syntax ------ @@ -23,7 +22,6 @@ Syntax #endif } PRProtoEnt; -.. _Fields: Fields ~~~~~~ diff --git a/docs/nspr/reference/prptrdiff.rst b/docs/nspr/reference/prptrdiff.rst index 19a887d654b3..29ff2bbb548c 100644 --- a/docs/nspr/reference/prptrdiff.rst +++ b/docs/nspr/reference/prptrdiff.rst @@ -3,7 +3,6 @@ PRPtrdiff Signed pointer difference type. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prseekwhence.rst b/docs/nspr/reference/prseekwhence.rst index 294cefb1aa0b..7f2ee04e5087 100644 --- a/docs/nspr/reference/prseekwhence.rst +++ b/docs/nspr/reference/prseekwhence.rst @@ -5,7 +5,6 @@ Specifies how to interpret the ``offset`` parameter in setting the file pointer associated with the ``fd`` parameter for the :ref:`PR_Seek` and :ref:`PR_Seek64` functions. -.. _Syntax: Syntax ------ @@ -20,7 +19,6 @@ Syntax PR_SEEK_END = 2 } PRSeekWhence; -.. _Enumerators: Enumerators ~~~~~~~~~~~ diff --git a/docs/nspr/reference/prsize.rst b/docs/nspr/reference/prsize.rst index 6488223290c9..5710c24dd7a2 100644 --- a/docs/nspr/reference/prsize.rst +++ b/docs/nspr/reference/prsize.rst @@ -4,7 +4,6 @@ PRSize A type for representing the size of an object (not the size of a pointer). This is the same as the corresponding type in ``libc``. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prsocketoptiondata.rst b/docs/nspr/reference/prsocketoptiondata.rst index 86360da42a20..8e8aa71a91c3 100644 --- a/docs/nspr/reference/prsocketoptiondata.rst +++ b/docs/nspr/reference/prsocketoptiondata.rst @@ -5,7 +5,6 @@ Type for structure used with :ref:`PR_GetSocketOption` and :ref:`PR_SetSocketOption` to specify options for file descriptors that represent sockets. -.. _Syntax: Syntax ------ @@ -37,7 +36,6 @@ Syntax } value; } PRSocketOptionData; -.. _Fields: Fields ~~~~~~ @@ -75,7 +73,6 @@ The structure has the following fields: ``mcast_if`` IP multicast interface address. -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/prsockoption.rst b/docs/nspr/reference/prsockoption.rst index 98abd4c6b64a..9295b34d0e0d 100644 --- a/docs/nspr/reference/prsockoption.rst +++ b/docs/nspr/reference/prsockoption.rst @@ -4,7 +4,6 @@ PRSockOption Enumeration type used in the ``option`` field of :ref:`PRSocketOptionData` to form the name portion of a name-value pair. -.. _Syntax: Syntax ------ @@ -32,7 +31,6 @@ Syntax PR_SockOpt_Last } PRSockOption; -.. _Enumerators: Enumerators ~~~~~~~~~~~ @@ -72,7 +70,6 @@ The enumeration has the following enumerators: ``PR_SockOpt_Last`` Always one greater than the maximum valid socket option numerator. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prstaticlinktable.rst b/docs/nspr/reference/prstaticlinktable.rst index fef33f79bdf8..2ad859585ebd 100644 --- a/docs/nspr/reference/prstaticlinktable.rst +++ b/docs/nspr/reference/prstaticlinktable.rst @@ -8,7 +8,6 @@ function that the library exports. If, during initialization, such entries are manually created, then future attempts to link to the symbols can be treated in a consistent fashion. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prstatus.rst b/docs/nspr/reference/prstatus.rst index 2145a5ae931b..3db7798ce6e4 100644 --- a/docs/nspr/reference/prstatus.rst +++ b/docs/nspr/reference/prstatus.rst @@ -3,7 +3,6 @@ PRStatus Type for status code returned by some functions. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prthread.rst b/docs/nspr/reference/prthread.rst index 600b6531e9a4..1da91a6b23f4 100644 --- a/docs/nspr/reference/prthread.rst +++ b/docs/nspr/reference/prthread.rst @@ -3,7 +3,6 @@ PRThread An NSPR thread. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef struct PRThread PRThread; -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/prthreadpool.rst b/docs/nspr/reference/prthreadpool.rst index c3537a05036f..54c078897f4c 100644 --- a/docs/nspr/reference/prthreadpool.rst +++ b/docs/nspr/reference/prthreadpool.rst @@ -1,7 +1,6 @@ PRThreadPool ============ -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prthreadpriority.rst b/docs/nspr/reference/prthreadpriority.rst index 0f045cb44720..5bc00b64f440 100644 --- a/docs/nspr/reference/prthreadpriority.rst +++ b/docs/nspr/reference/prthreadpriority.rst @@ -3,7 +3,6 @@ PRThreadPriority A thread's priority setting. -.. _Syntax: Syntax ------ @@ -22,7 +21,6 @@ Syntax PR_PRIORITY_LAST = 3 } PRThreadPriority; -.. _Enumerators: Enumerators ~~~~~~~~~~~ @@ -43,7 +41,6 @@ Enumerators ``PR_PRIORITY_LAST`` Placeholder -.. _Description: Description ----------- @@ -57,7 +54,6 @@ that a higher-priority thread might expect relative to a lower-priority thread. This preference is still subject to resource availability and must not be used in place of proper synchronization. -.. _See_Also: See Also -------- diff --git a/docs/nspr/reference/prthreadprivatedtor.rst b/docs/nspr/reference/prthreadprivatedtor.rst index 93e0ddcb2c3a..48307ccb8352 100644 --- a/docs/nspr/reference/prthreadprivatedtor.rst +++ b/docs/nspr/reference/prthreadprivatedtor.rst @@ -4,7 +4,6 @@ PRThreadPrivateDTOR The destructor function passed to PR_NewThreadPrivateIndex that is associated with the resulting thread private index. -.. _Syntax: Syntax ------ @@ -15,7 +14,6 @@ Syntax typedef void (PR_CALLBACK *PRThreadPrivateDTOR)(void *priv); -.. _Description: Description ~~~~~~~~~~~ diff --git a/docs/nspr/reference/prthreadscope.rst b/docs/nspr/reference/prthreadscope.rst index be6124247541..ce8551c99f51 100644 --- a/docs/nspr/reference/prthreadscope.rst +++ b/docs/nspr/reference/prthreadscope.rst @@ -4,7 +4,6 @@ PRThreadScope The scope of an NSPR thread, specified as a parameter to :ref:`PR_CreateThread` or returned by :ref:`PR_GetThreadScope`. -.. _Syntax: Syntax ------ @@ -19,7 +18,6 @@ Syntax PR_GLOBAL_BOUND_THREAD } PRThreadScope; -.. _Enumerators: Enumerators ~~~~~~~~~~~ @@ -31,7 +29,6 @@ Enumerators ``PR_GLOBAL_BOUND_THREAD`` A global bound (kernel) thread, scheduled by the host OS -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prthreadstack.rst b/docs/nspr/reference/prthreadstack.rst index ba627a946f57..e0d147aefeea 100644 --- a/docs/nspr/reference/prthreadstack.rst +++ b/docs/nspr/reference/prthreadstack.rst @@ -27,5 +27,5 @@ Syntax .. _Definition_2: -  + - diff --git a/docs/nspr/reference/prthreadstate.rst b/docs/nspr/reference/prthreadstate.rst index d9d27ca3d5ef..af4614961972 100644 --- a/docs/nspr/reference/prthreadstate.rst +++ b/docs/nspr/reference/prthreadstate.rst @@ -3,7 +3,6 @@ PRThreadState A thread's thread state is either joinable or unjoinable. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PR_UNJOINABLE_THREAD } PRThreadState; -.. _Enumerators: Enumerators ~~~~~~~~~~~ @@ -33,7 +31,6 @@ Enumerators their root function until :ref:`PR_JoinThread` is called. This approach facilitates management of the process' critical resources. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prthreadtype.rst b/docs/nspr/reference/prthreadtype.rst index f5cd0cbe91c3..79fe78f6c603 100644 --- a/docs/nspr/reference/prthreadtype.rst +++ b/docs/nspr/reference/prthreadtype.rst @@ -4,7 +4,6 @@ PRThreadType The type of an NSPR thread, specified as a parameter to :ref:`PR_CreateThread`. -.. _Syntax: Syntax ------ @@ -18,7 +17,6 @@ Syntax PR_SYSTEM_THREAD } PRThreadType; -.. _Enumerators: Enumerators ~~~~~~~~~~~ @@ -30,7 +28,6 @@ Enumerators NSPR ignores threads of type ``PR_SYSTEM_THREAD`` when determining when a call to :ref:`PR_Cleanup` should return. -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prtime.rst b/docs/nspr/reference/prtime.rst index 8e6a1dfe4247..b75eec7b9e9d 100644 --- a/docs/nspr/reference/prtime.rst +++ b/docs/nspr/reference/prtime.rst @@ -3,7 +3,6 @@ PRTime A representation of absolute times. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef PRInt64 PRTime; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prtimeparameters.rst b/docs/nspr/reference/prtimeparameters.rst index 193ed9e4b688..9bcbe909ac73 100644 --- a/docs/nspr/reference/prtimeparameters.rst +++ b/docs/nspr/reference/prtimeparameters.rst @@ -3,7 +3,6 @@ PRTimeParameters A representation of time zone information. -.. _Syntax: Syntax ------ @@ -17,7 +16,6 @@ Syntax PRInt32 tp_dst_offset; } PRTimeParameters; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/prtimeparamfn.rst b/docs/nspr/reference/prtimeparamfn.rst index 73d6f1c87cb0..84d5ac4970f9 100644 --- a/docs/nspr/reference/prtimeparamfn.rst +++ b/docs/nspr/reference/prtimeparamfn.rst @@ -4,7 +4,6 @@ PRTimeParamFn This type defines a callback function to calculate and return the time parameter offsets from a calendar time object in GMT. -.. _Syntax: Syntax ------ @@ -16,7 +15,6 @@ Syntax typedef PRTimeParameters (PR_CALLBACK_DECL *PRTimeParamFn) (const PRExplodedTime *gmt); -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pruint16.rst b/docs/nspr/reference/pruint16.rst index 096358e01a54..ae01198d52ea 100644 --- a/docs/nspr/reference/pruint16.rst +++ b/docs/nspr/reference/pruint16.rst @@ -3,7 +3,6 @@ PRUint16 Guaranteed to be an unsigned 16-bit integer on all platforms. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pruint32.rst b/docs/nspr/reference/pruint32.rst index 77a5ca121a3c..c8d6e93f0a13 100644 --- a/docs/nspr/reference/pruint32.rst +++ b/docs/nspr/reference/pruint32.rst @@ -3,7 +3,6 @@ PRUint32 Guaranteed to be an unsigned 32-bit integer on all platforms. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedefdefinition PRUint32; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pruint64.rst b/docs/nspr/reference/pruint64.rst index 06ba6a0ccb38..242cbe7c1e98 100644 --- a/docs/nspr/reference/pruint64.rst +++ b/docs/nspr/reference/pruint64.rst @@ -3,7 +3,6 @@ PRUint64 Guaranteed to be an unsigned 64-bit integer on all platforms. -.. _Syntax: Syntax ------ @@ -14,7 +13,6 @@ Syntax typedef definition PRUint64; -.. _Description: Description ----------- diff --git a/docs/nspr/reference/pruint8.rst b/docs/nspr/reference/pruint8.rst index a7d0fc46b242..462d8f65139d 100644 --- a/docs/nspr/reference/pruint8.rst +++ b/docs/nspr/reference/pruint8.rst @@ -4,7 +4,6 @@ PRUint8 Guaranteed to be an unsigned 8-bit integer on all platforms. There is no type equivalent to a plain ``char``. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/pruintn.rst b/docs/nspr/reference/pruintn.rst index ec3a038ea2f5..7f577b3b6956 100644 --- a/docs/nspr/reference/pruintn.rst +++ b/docs/nspr/reference/pruintn.rst @@ -6,7 +6,6 @@ variables. It is guaranteed to be at least 16 bits, though various architectures may define it to be wider (for example, 32 or even 64 bits). This types is never valid for fields of a structure. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/prunichar.rst b/docs/nspr/reference/prunichar.rst index 4136d63621b6..077fb118c804 100644 --- a/docs/nspr/reference/prunichar.rst +++ b/docs/nspr/reference/prunichar.rst @@ -5,7 +5,6 @@ An unsigned 16-bit type, like ``char`` in Java or the "characters" of a JavaScript string defined in `/mozilla/xpcom/base/nscore.h `__. -.. _Syntax: Syntax ------ @@ -13,7 +12,7 @@ Syntax .. code:: eval #if defined(NS_WIN32) -   typedef wchar_t PRUnichar; + typedef wchar_t PRUnichar; #else -   typedef PRUInt16 PRUnichar; + typedef PRUInt16 PRUnichar; #endif diff --git a/docs/nspr/reference/pruptrdiff.rst b/docs/nspr/reference/pruptrdiff.rst index d0ed7fe0c0c7..f305d42f0a47 100644 --- a/docs/nspr/reference/pruptrdiff.rst +++ b/docs/nspr/reference/pruptrdiff.rst @@ -3,7 +3,6 @@ PRUptrdiff Unsigned pointer difference type. -.. _Syntax: Syntax ------ diff --git a/docs/nspr/reference/threads.rst b/docs/nspr/reference/threads.rst index 23d89b098116..fdcdcc271e14 100644 --- a/docs/nspr/reference/threads.rst +++ b/docs/nspr/reference/threads.rst @@ -66,9 +66,9 @@ Creating, Joining, and Identifying Threads terminates. - :ref:`PR_GetCurrentThread` returns the current thread object for the currently running code. - - :ref:`PR_AttachThread`` associates a ``PRThread` object with an existing + - :ref:`PR_AttachThread`` associates a :ref:`PRThread` object with an existing native thread. - - :ref:`PR_DetachThread`` disassociates a ``PRThread` object from a native + - :ref:`PR_DetachThread`` disassociates a :ref:`PRThread` object from a native thread. .. _Controlling_Thread_Priorities: diff --git a/tools/lint/spell/exclude-list.txt b/tools/lint/spell/exclude-list.txt index 1b6f595099ec..540b70ec2dca 100644 --- a/tools/lint/spell/exclude-list.txt +++ b/tools/lint/spell/exclude-list.txt @@ -14,4 +14,5 @@ referer dur ue tring +delink