From: mike Date: Wed, 20 Mar 2013 18:14:10 +0000 (+0000) Subject: Cleanup, documentation. X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=026962f42d84967052b5ecf548030c191ee373f3;p=thirdparty%2Fcups.git 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 c8834df418..00882baca6 100644 --- 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 240e56cd54..d1e6844281 100644 --- 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 d57326f751..061b765073 100644 --- 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 9e64f48311..cc6daf321d 100644 --- 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 0395324109..d6736d9ddb 100644 --- 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.

-

httpAssembleUUID

+

 CUPS 1.7 httpAssembleUUID

Assemble a name-based UUID URN conforming to RFC 4122.

char *httpAssembleUUID (
@@ -1686,7 +1686,9 @@ char *httpAssembleUUID (
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.

-The buffer needs to be at least 46 bytes in size.

+The buffer needs to be at least 46 bytes in size. + +

httpBlocking

Set blocking/non-blocking behavior on a connection.

@@ -2815,8 +2817,8 @@ void httpSetDefaultField (

Value

Discussion

-

Currently only HTTP_FIELD_ACCEPT_ENCODING, HTTP_FIELD_SERVER, and -HTTP_FIELD_USER_AGENT can be set. +

Currently only HTTP_FIELD_ACCEPT_ENCODING, HTTP_FIELD_SERVER, +and HTTP_FIELD_USER_AGENT can be set.

 CUPS 1.2/OS X 10.5 httpSetExpect

@@ -5782,6 +5784,28 @@ are server-oriented...

Fold to make booklet
IPP_FINISHINGS_COVER
Add cover
+
IPP_FINISHINGS_CUPS_FOLD_ACCORDIAN
+
Accordian-fold the paper vertically into four sections
+
IPP_FINISHINGS_CUPS_FOLD_DOUBLE_GATE
+
Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically
+
IPP_FINISHINGS_CUPS_FOLD_GATE
+
Fold the top and bottom quarters of the paper towards the midline
+
IPP_FINISHINGS_CUPS_FOLD_HALF
+
Fold the paper in half vertically
+
IPP_FINISHINGS_CUPS_FOLD_HALF_Z
+
Fold the paper in half horizontally, then Z-fold the paper vertically
+
IPP_FINISHINGS_CUPS_FOLD_LEFT_GATE
+
Fold the top quarter of the paper towards the midline
+
IPP_FINISHINGS_CUPS_FOLD_LETTER
+
Fold the paper into three sections vertically; sometimes also known as a C fold
+
IPP_FINISHINGS_CUPS_FOLD_PARALLEL
+
Fold the paper in half vertically two times, yielding four sections
+
IPP_FINISHINGS_CUPS_FOLD_POSTER
+
Fold the paper in half horizontally and vertically; sometimes also called a cross fold
+
IPP_FINISHINGS_CUPS_FOLD_RIGHT_GATE
+
Fold the bottom quarter of the paper towards the midline
+
IPP_FINISHINGS_CUPS_FOLD_Z
+
Fold the paper vertically into three sections, forming a Z
IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT
Punch 1 hole bottom left
IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT
@@ -5826,7 +5850,7 @@ are server-oriented...

Stitch along top edge
IPP_FINISHINGS_FOLD
Fold (any type)
-
IPP_FINISHINGS_JOB_OFFSET
+
IPP_FINISHINGS_JOG_OFFSET
Offset for binding (any type)
IPP_FINISHINGS_NONE
No finishing