Cleanup, documentation.

git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@10922 7a7537e8-13f0-0310-91df-b6672ffda945

diff --git a/cups/http-addr.c b/cups/http-addr.c
index c8834df4189917ec1589a501a596233cec03dbb9..00882baca6320f625acca6f31e3efbc367439d1e 100644 (file)
--- a/cups/http-addr.c
+++ b/cups/http-addr.c
@@ -3,7 +3,7 @@
  *
  *   HTTP address routines for CUPS.
  *
- *   Copyright 2007-2012 by Apple Inc.
+ *   Copyright 2007-2013 by Apple Inc.
  *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
  *
  *   These coded instructions, statements, and computer programs are the

diff --git a/cups/http-addrlist.c b/cups/http-addrlist.c
index 240e56cd549983a0fe7991ebb61cb08b82dc973d..d1e6844281fda5551d3daaf4ec0b99609f9d1a53 100644 (file)
--- a/cups/http-addrlist.c
+++ b/cups/http-addrlist.c
@@ -59,7 +59,7 @@ httpAddrConnect(
  * 'httpAddrConnect2()' - Connect to any of the addresses in the list with a
  *                        timeout and optional cancel.
  *
- * @since CUPS 1.6/OS X 10.8@
+ * @since CUPS 1.7@
  */
 
 http_addrlist_t *                      /* O - Connected address or NULL on failure */

diff --git a/cups/http-support.c b/cups/http-support.c
index d57326f751f491234e3e2c3463e83c6fe5cd98b6..061b765073e23b560d76d8004737e5cd58049606 100644 (file)
--- a/cups/http-support.c
+++ b/cups/http-support.c
@@ -474,6 +474,8 @@ httpAssembleURIf(
  * number.  The result is formatted as a UUID URN as defined in RFC 4122.
  *
  * The buffer needs to be at least 46 bytes in size.
+ *
+ * @since CUPS 1.7@
  */
 
 char *                                 /* I - UUID string */

diff --git a/cups/http.c b/cups/http.c
index 9e64f48311c3422b7b2eb79b31d81c5cc93081d6..cc6daf321d0af3f414483f3032a7c6b7e9c4d360 100644 (file)
--- a/cups/http.c
+++ b/cups/http.c
@@ -47,11 +47,11 @@
  *   _httpFreeCredentials()      - Free internal credentials.
  *   httpFreeCredentials()       - Free an array of credentials.
  *   httpGet()                   - Send a GET request to the server.
- *   httpGetContentEncoding()    - Get a common content encoding, if any,
- *                                 between the client and server.
  *   httpGetAuthString()         - Get the current authorization string.
  *   httpGetBlocking()           - Get the blocking/non-block state of a
  *                                 connection.
+ *   httpGetContentEncoding()    - Get a common content encoding, if any,
+ *                                 between the client and server.
  *   httpGetCookie()             - Get any cookie data from the response.
  *   httpGetExpect()             - Get the value of the Expect header, if any.
  *   httpGetFd()                 - Get the file descriptor associated with a
@@ -1043,6 +1043,40 @@ httpGet(http_t     *http,                /* I - Connection to server */
 }
 
 
+/*
+ * 'httpGetAuthString()' - Get the current authorization string.
+ *
+ * The authorization string is set by cupsDoAuthentication() and
+ * httpSetAuthString().  Use httpGetAuthString() to retrieve the
+ * string to use with httpSetField() for the HTTP_FIELD_AUTHORIZATION
+ * value.
+ *
+ * @since CUPS 1.3/OS X 10.5@
+ */
+
+char *                                 /* O - Authorization string */
+httpGetAuthString(http_t *http)                /* I - Connection to server */
+{
+  if (http)
+    return (http->authstring);
+  else
+    return (NULL);
+}
+
+
+/*
+ * 'httpGetBlocking()' - Get the blocking/non-block state of a connection.
+ *
+ * @since CUPS 1.2/OS X 10.5@
+ */
+
+int                                    /* O - 1 if blocking, 0 if non-blocking */
+httpGetBlocking(http_t *http)          /* I - Connection to server */
+{
+  return (http ? http->blocking : 0);
+}
+
+
 /*
  * 'httpGetContentEncoding()' - Get a common content encoding, if any, between
  *                              the client and server.
@@ -1131,40 +1165,6 @@ httpGetContentEncoding(http_t *http)     /* I - Connection to client/server */
 }
 
 
-/*
- * 'httpGetAuthString()' - Get the current authorization string.
- *
- * The authorization string is set by cupsDoAuthentication() and
- * httpSetAuthString().  Use httpGetAuthString() to retrieve the
- * string to use with httpSetField() for the HTTP_FIELD_AUTHORIZATION
- * value.
- *
- * @since CUPS 1.3/OS X 10.5@
- */
-
-char *                                 /* O - Authorization string */
-httpGetAuthString(http_t *http)                /* I - Connection to server */
-{
-  if (http)
-    return (http->authstring);
-  else
-    return (NULL);
-}
-
-
-/*
- * 'httpGetBlocking()' - Get the blocking/non-block state of a connection.
- *
- * @since CUPS 1.2/OS X 10.5@
- */
-
-int                                    /* O - 1 if blocking, 0 if non-blocking */
-httpGetBlocking(http_t *http)          /* I - Connection to server */
-{
-  return (http ? http->blocking : 0);
-}
-
-
 /*
  * 'httpGetCookie()' - Get any cookie data from the response.
  *
@@ -2898,8 +2898,8 @@ httpSetCookie(http_t     *http,           /* I - Connection */
 /*
  * 'httpSetDefaultField()' - Set the default value of an HTTP header.
  *
- * Currently only HTTP_FIELD_ACCEPT_ENCODING, HTTP_FIELD_SERVER, and
- * HTTP_FIELD_USER_AGENT can be set.
+ * Currently only @code HTTP_FIELD_ACCEPT_ENCODING@, @code HTTP_FIELD_SERVER@,
+ * and @code HTTP_FIELD_USER_AGENT@ can be set.
  *
  * @since CUPS 1.7@
  */

diff --git a/doc/help/api-httpipp.html b/doc/help/api-httpipp.html
index 0395324109bb2b454f7a56f9e4d5ac9473ad7710..d6736d9ddb787ab4f714be2292a5e7693be9f18b 100644 (file)
--- a/doc/help/api-httpipp.html
+++ b/doc/help/api-httpipp.html
@@ -1653,7 +1653,7 @@ this function in place of traditional string functions whenever
 you need to create a URI string.
 
 </p>
-<h3 class="function"><a name="httpAssembleUUID">httpAssembleUUID</a></h3>
+<h3 class="function"><span class="info">&nbsp;CUPS 1.7&nbsp;</span><a name="httpAssembleUUID">httpAssembleUUID</a></h3>
 <p class="description">Assemble a name-based UUID URN conforming to RFC 4122.</p>
 <p class="code">
 char *httpAssembleUUID (<br>
@@ -1686,7 +1686,9 @@ char *httpAssembleUUID (<br>
 name, port number, random data, and optionally an object name and/or object
 number.  The result is formatted as a UUID URN as defined in RFC 4122.<br>
 <br>
-The buffer needs to be at least 46 bytes in size.</p>
+The buffer needs to be at least 46 bytes in size.
+
+</p>
 <h3 class="function"><a name="httpBlocking">httpBlocking</a></h3>
 <p class="description">Set blocking/non-blocking behavior on a connection.</p>
 <p class="code">
@@ -2815,8 +2817,8 @@ void httpSetDefaultField (<br>
 <dd class="description">Value</dd>
 </dl>
 <h4 class="discussion">Discussion</h4>
-<p class="discussion">Currently only HTTP_FIELD_ACCEPT_ENCODING, HTTP_FIELD_SERVER, and
-HTTP_FIELD_USER_AGENT can be set.
+<p class="discussion">Currently only <code>HTTP_FIELD_ACCEPT_ENCODING</code>, <code>HTTP_FIELD_SERVER</code>,
+and <code>HTTP_FIELD_USER_AGENT</code> can be set.
 
 </p>
 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/OS X 10.5&nbsp;</span><a name="httpSetExpect">httpSetExpect</a></h3>
@@ -5782,6 +5784,28 @@ are server-oriented...</p>
 <dd class="description">Fold to make booklet</dd>
 <dt>IPP_FINISHINGS_COVER </dt>
 <dd class="description">Add cover</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_ACCORDIAN </dt>
+<dd class="description">Accordian-fold the paper vertically into four sections</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_DOUBLE_GATE </dt>
+<dd class="description">Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_GATE </dt>
+<dd class="description">Fold the top and bottom quarters of the paper towards the midline</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_HALF </dt>
+<dd class="description">Fold the paper in half vertically</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_HALF_Z </dt>
+<dd class="description">Fold the paper in half horizontally, then Z-fold the paper vertically</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_LEFT_GATE </dt>
+<dd class="description">Fold the top quarter of the paper towards the midline</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_LETTER </dt>
+<dd class="description">Fold the paper into three sections vertically; sometimes also known as a C fold</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_PARALLEL </dt>
+<dd class="description">Fold the paper in half vertically two times, yielding four sections</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_POSTER </dt>
+<dd class="description">Fold the paper in half horizontally and vertically; sometimes also called a cross fold</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_RIGHT_GATE </dt>
+<dd class="description">Fold the bottom quarter of the paper towards the midline</dd>
+<dt>IPP_FINISHINGS_CUPS_FOLD_Z </dt>
+<dd class="description">Fold the paper vertically into three sections, forming a Z</dd>
 <dt>IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT </dt>
 <dd class="description">Punch 1 hole bottom left</dd>
 <dt>IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT </dt>
@@ -5826,7 +5850,7 @@ are server-oriented...</p>
 <dd class="description">Stitch along top edge</dd>
 <dt>IPP_FINISHINGS_FOLD </dt>
 <dd class="description">Fold (any type)</dd>
-<dt>IPP_FINISHINGS_JOB_OFFSET </dt>
+<dt>IPP_FINISHINGS_JOG_OFFSET </dt>
 <dd class="description">Offset for binding (any type)</dd>
 <dt>IPP_FINISHINGS_NONE </dt>
 <dd class="description">No finishing</dd>