Update documentation with correct spelling of papplJob functions.

michaelrsweet · Oct 6, 2023 · 1404ab6 · 1404ab6
1 parent d91e4ec
commit 1404ab6
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 50 deletions.
diff --git a/doc/pappl.html b/doc/pappl.html
@@ -279,8 +279,6 @@ <h2 class="title">Contents</h2>
 <li><a href="#the-self-test-page-callback">The Self-Test Page Callback</a></li>
 </ul></li>
 <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents">
-<li><a href="#pappJobResume">pappJobResume</a></li>
-<li><a href="#pappJobSuspend">pappJobSuspend</a></li>
 <li><a href="#papplClientGetCSRFToken">papplClientGetCSRFToken</a></li>
 <li><a href="#papplClientGetCookie">papplClientGetCookie</a></li>
 <li><a href="#papplClientGetForm">papplClientGetForm</a></li>
@@ -369,13 +367,15 @@ <h2 class="title">Contents</h2>
 <li><a href="#papplJobIsCanceled">papplJobIsCanceled</a></li>
 <li><a href="#papplJobOpenFile">papplJobOpenFile</a></li>
 <li><a href="#papplJobRelease">papplJobRelease</a></li>
+<li><a href="#papplJobResume">papplJobResume</a></li>
 <li><a href="#papplJobRetain">papplJobRetain</a></li>
 <li><a href="#papplJobSetCopiesCompleted">papplJobSetCopiesCompleted</a></li>
 <li><a href="#papplJobSetData">papplJobSetData</a></li>
 <li><a href="#papplJobSetImpressions">papplJobSetImpressions</a></li>
 <li><a href="#papplJobSetImpressionsCompleted">papplJobSetImpressionsCompleted</a></li>
 <li><a href="#papplJobSetMessage">papplJobSetMessage</a></li>
 <li><a href="#papplJobSetReasons">papplJobSetReasons</a></li>
+<li><a href="#papplJobSuspend">papplJobSuspend</a></li>
 <li><a href="#papplLocFormatString">papplLocFormatString</a></li>
 <li><a href="#papplLocGetDefaultMediaSizeName">papplLocGetDefaultMediaSizeName</a></li>
 <li><a href="#papplLocGetString">papplLocGetString</a></li>
@@ -1479,28 +1479,6 @@ <h3 class="title" id="the-self-test-page-callback">The Self-Test Page Callback</
 </code></pre>
 <p>When the callback returns a filename (copied to the specified buffer), that file will be queued as a job for the printer. The callback can also try opening the device using the <a href="#papplPrinterOpenDevice"><code>papplPrinterOpenDevice</code></a> function to send a printer self-test command instead - in this case the callback must return <code>NULL</code> to indicate there is no file to be printed.</p>
 <h2 class="title"><a id="FUNCTIONS">Functions</a></h2>
-<h3 class="function"><a id="pappJobResume">pappJobResume</a></h3>
-<p class="description">Resume processing of a job.</p>
-<p class="code">
-void pappJobResume(<a href="#pappl_job_t">pappl_job_t</a> *job, <a href="#pappl_jreason_t">pappl_jreason_t</a> remove);</p>
-<h4 class="parameters">Parameters</h4>
-<table class="list"><tbody>
-<tr><th>job</th>
-<td class="description">Job</td></tr>
-<tr><th>remove</th>
-<td class="description">Reasons to remove from &quot;job-state-reasons&quot;</td></tr>
-</tbody></table>
-<h3 class="function"><a id="pappJobSuspend">pappJobSuspend</a></h3>
-<p class="description">Temporarily stop processing of a job.</p>
-<p class="code">
-void pappJobSuspend(<a href="#pappl_job_t">pappl_job_t</a> *job, <a href="#pappl_jreason_t">pappl_jreason_t</a> add);</p>
-<h4 class="parameters">Parameters</h4>
-<table class="list"><tbody>
-<tr><th>job</th>
-<td class="description">Job</td></tr>
-<tr><th>add</th>
-<td class="description">Reasons to add to &quot;job-state-reasons&quot;</td></tr>
-</tbody></table>
 <h3 class="function"><a id="papplClientGetCSRFToken">papplClientGetCSRFToken</a></h3>
 <p class="description">Get a unique Cross-Site Request Forgery token
                               string.</p>
@@ -3204,6 +3182,17 @@ <h4 class="returnvalue">Return Value</h4>
 <p class="description"><code>true</code> on success, <code>false</code> on failure</p>
 <h4 class="discussion">Discussion</h4>
 <p class="discussion">This function releases a held job for printing.</p>
+<h3 class="function"><a id="papplJobResume">papplJobResume</a></h3>
+<p class="description">Resume processing of a job.</p>
+<p class="code">
+void papplJobResume(<a href="#pappl_job_t">pappl_job_t</a> *job, <a href="#pappl_jreason_t">pappl_jreason_t</a> remove);</p>
+<h4 class="parameters">Parameters</h4>
+<table class="list"><tbody>
+<tr><th>job</th>
+<td class="description">Job</td></tr>
+<tr><th>remove</th>
+<td class="description">Reasons to remove from &quot;job-state-reasons&quot;</td></tr>
+</tbody></table>
 <h3 class="function"><a id="papplJobRetain">papplJobRetain</a></h3>
 <p class="description">Retain a completed job until the specified time.</p>
 <p class="code">
@@ -3316,6 +3305,17 @@ <h4 class="parameters">Parameters</h4>
 <h4 class="discussion">Discussion</h4>
 <p class="discussion">This function updates the job state reasons bitfield.  The &quot;remove&quot; bits
 are cleared first, then the &quot;add&quot; bits are set.</p>
+<h3 class="function"><a id="papplJobSuspend">papplJobSuspend</a></h3>
+<p class="description">Temporarily stop processing of a job.</p>
+<p class="code">
+void papplJobSuspend(<a href="#pappl_job_t">pappl_job_t</a> *job, <a href="#pappl_jreason_t">pappl_jreason_t</a> add);</p>
+<h4 class="parameters">Parameters</h4>
+<table class="list"><tbody>
+<tr><th>job</th>
+<td class="description">Job</td></tr>
+<tr><th>add</th>
+<td class="description">Reasons to add to &quot;job-state-reasons&quot;</td></tr>
+</tbody></table>
 <h3 class="function"><a id="papplLocFormatString">papplLocFormatString</a></h3>
 <p class="description">Format a localized string into a buffer.</p>
 <p class="code">

diff --git a/man/pappl-client.3 b/man/pappl-client.3
@@ -1,4 +1,4 @@
-.TH pappl-client 3 "pappl client functions" "2023-09-28" "pappl client functions"
+.TH pappl-client 3 "pappl client functions" "2023-10-06" "pappl client functions"
 .SH NAME
 pappl-client \- pappl client functions
 .SH LIBRARY

diff --git a/man/pappl-device.3 b/man/pappl-device.3
@@ -1,4 +1,4 @@
-.TH pappl-device 3 "pappl device functions" "2023-09-28" "pappl device functions"
+.TH pappl-device 3 "pappl device functions" "2023-10-06" "pappl device functions"
 .SH NAME
 pappl-device \- pappl device functions
 .SH LIBRARY

diff --git a/man/pappl-job.3 b/man/pappl-job.3
@@ -1,4 +1,4 @@
-.TH pappl-job 3 "pappl job functions" "2023-09-28" "pappl job functions"
+.TH pappl-job 3 "pappl job functions" "2023-10-06" "pappl job functions"
 .SH NAME
 pappl-job \- pappl job functions
 .SH LIBRARY
@@ -259,24 +259,6 @@ PAPPL_JREASON_WARNINGS_DETECTED
 .br
 \'warnings-detected'
 .SH FUNCTIONS
-.SS pappJobResume
-Resume processing of a job.
-.PP
-.nf
-void pappJobResume (
-    pappl_job_t *job,
-    pappl_jreason_t remove
-);
-.fi
-.SS pappJobSuspend
-Temporarily stop processing of a job.
-.PP
-.nf
-void pappJobSuspend (
-    pappl_job_t *job,
-    pappl_jreason_t add
-);
-.fi
 .SS papplJobCancel
 Cancel a job.
 .PP
@@ -630,6 +612,15 @@ bool  papplJobRelease (
 .fi
 .PP
 This function releases a held job for printing.
+.SS papplJobResume
+Resume processing of a job.
+.PP
+.nf
+void papplJobResume (
+    pappl_job_t *job,
+    pappl_jreason_t remove
+);
+.fi
 .SS papplJobRetain
 Retain a completed job until the specified time.
 .PP
@@ -721,6 +712,15 @@ void papplJobSetReasons (
 .PP
 This function updates the job state reasons bitfield.  The "remove" bits
 are cleared first, then the "add" bits are set.
+.SS papplJobSuspend
+Temporarily stop processing of a job.
+.PP
+.nf
+void papplJobSuspend (
+    pappl_job_t *job,
+    pappl_jreason_t add
+);
+.fi
 .SS papplPrinterFindJob
 Find a job.
 .PP

diff --git a/man/pappl-log.3 b/man/pappl-log.3
@@ -1,4 +1,4 @@
-.TH pappl-log 3 "pappl logging functions" "2023-09-28" "pappl logging functions"
+.TH pappl-log 3 "pappl logging functions" "2023-10-06" "pappl logging functions"
 .SH NAME
 pappl-log \- pappl logging functions
 .SH LIBRARY

diff --git a/man/pappl-mainloop.3 b/man/pappl-mainloop.3
@@ -1,4 +1,4 @@
-.TH pappl-mainloop 3 "pappl main loop functions" "2023-09-28" "pappl main loop functions"
+.TH pappl-mainloop 3 "pappl main loop functions" "2023-10-06" "pappl main loop functions"
 .SH NAME
 pappl-mainloop \- pappl main loop functions
 .SH LIBRARY

diff --git a/man/pappl-printer.3 b/man/pappl-printer.3
@@ -1,4 +1,4 @@
-.TH pappl-printer 3 "pappl printer functions" "2023-09-28" "pappl printer functions"
+.TH pappl-printer 3 "pappl printer functions" "2023-10-06" "pappl printer functions"
 .SH NAME
 pappl-printer \- pappl printer functions
 .SH LIBRARY

diff --git a/man/pappl-resource.3 b/man/pappl-resource.3
@@ -1,4 +1,4 @@
-.TH pappl-resource 3 "pappl resource functions" "2023-09-28" "pappl resource functions"
+.TH pappl-resource 3 "pappl resource functions" "2023-10-06" "pappl resource functions"
 .SH NAME
 pappl-resource \- pappl resource functions
 .SH LIBRARY

diff --git a/man/pappl-system.3 b/man/pappl-system.3
@@ -1,4 +1,4 @@
-.TH pappl-system 3 "pappl system functions" "2023-09-28" "pappl system functions"
+.TH pappl-system 3 "pappl system functions" "2023-10-06" "pappl system functions"
 .SH NAME
 pappl-system \- pappl system functions
 .SH LIBRARY