From 305b3fd5371b88d3eb58fa7b03cea4c2b93b1258 Mon Sep 17 00:00:00 2001 From: mike Date: Wed, 29 Aug 2012 19:52:04 +0000 Subject: [PATCH] Clean up documentation for new API functions. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@10583 7a7537e8-13f0-0310-91df-b6672ffda945 --- cups/dest-options.c | 34 ++++++++++++++++------------------ doc/help/api-cups.html | 34 ++++++++++++++++------------------ 2 files changed, 32 insertions(+), 36 deletions(-) diff --git a/cups/dest-options.c b/cups/dest-options.c index 32616a683c..d8eff72e5b 100644 --- a/cups/dest-options.c +++ b/cups/dest-options.c @@ -269,13 +269,13 @@ cupsCheckDestSupported( * Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if * there was an unrecoverable error such as a resolver loop. * - * If "num_conflicts" and "conflicts" are not NULL, they are set to contain the - * list of conflicting option/value pairs. Similarly, if "num_resolved" and - * "resolved" are not NULL they will be set to the list of changes needed to - * resolve the conflict. + * If "num_conflicts" and "conflicts" are not @code NULL@, they are set to + * contain the list of conflicting option/value pairs. Similarly, if + * "num_resolved" and "resolved" are not @code NULL@ they will be set to the + * list of changes needed to resolve the conflict. * * If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set - * to 0 and NULL, respectively, then the conflict cannot be resolved. + * to 0 and @code NULL@, respectively, then the conflict cannot be resolved. * * @since CUPS 1.6/OS X 10.8@ */ @@ -716,14 +716,13 @@ cupsFreeDestInfo(cups_dinfo_t *dinfo) /* I - Destination information */ /* * 'cupsGetDestMediaByName()' - Get media names, dimensions, and margins. * - * The "media" string is a PWG media name, while "width" and "length" are the - * dimensions in hundredths of millimeters. "flags" provides some matching + * The "media" string is a PWG media name. "Flags" provides some matching * guidance (multiple flags can be combined): * - * CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer - * CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size - * CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing - * CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size + * CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, + * CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, + * CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, + * CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and * CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the * size amongst the "ready" media. * @@ -782,14 +781,13 @@ cupsGetDestMediaByName( /* * 'cupsGetDestMediaBySize()' - Get media names, dimensions, and margins. * - * The "media" string is a PWG media name, while "width" and "length" are the - * dimensions in hundredths of millimeters. "flags" provides some matching - * guidance (multiple flags can be combined): + * "Width" and "length" are the dimensions in hundredths of millimeters. + * "Flags" provides some matching guidance (multiple flags can be combined): * - * CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer - * CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size - * CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing - * CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size + * CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, + * CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, + * CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, + * CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and * CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the * size amongst the "ready" media. * diff --git a/doc/help/api-cups.html b/doc/help/api-cups.html index 12534839da..53a443eae6 100644 --- a/doc/help/api-cups.html +++ b/doc/help/api-cups.html @@ -1410,13 +1410,13 @@ changed.
Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if there was an unrecoverable error such as a resolver loop.

-If "num_conflicts" and "conflicts" are not NULL, they are set to contain the -list of conflicting option/value pairs. Similarly, if "num_resolved" and -"resolved" are not NULL they will be set to the list of changes needed to -resolve the conflict.
+If "num_conflicts" and "conflicts" are not NULL, they are set to +contain the list of conflicting option/value pairs. Similarly, if +"num_resolved" and "resolved" are not NULL they will be set to the +list of changes needed to resolve the conflict.

If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set -to 0 and NULL, respectively, then the conflict cannot be resolved. +to 0 and NULL, respectively, then the conflict cannot be resolved.

 CUPS 1.6/OS X 10.8 cupsCopyDestInfo

@@ -1809,14 +1809,13 @@ int cupsGetDestMediaByName (

Return Value

1 on match, 0 on failure

Discussion

-

The "media" string is a PWG media name, while "width" and "length" are the -dimensions in hundredths of millimeters. "flags" provides some matching +

The "media" string is a PWG media name. "Flags" provides some matching guidance (multiple flags can be combined):

-CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer -CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size -CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing -CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size +CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, +CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, +CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, +CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the size amongst the "ready" media.

@@ -1859,14 +1858,13 @@ of millimeters

Return Value

1 on match, 0 on failure

Discussion

-

The "media" string is a PWG media name, while "width" and "length" are the -dimensions in hundredths of millimeters. "flags" provides some matching -guidance (multiple flags can be combined):
+

"Width" and "length" are the dimensions in hundredths of millimeters. +"Flags" provides some matching guidance (multiple flags can be combined):

-CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer -CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size -CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing -CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size +CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, +CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, +CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, +CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the size amongst the "ready" media.

-- 2.47.3