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

diff --git a/cups/dest-options.c b/cups/dest-options.c
index 32616a683c1426637919acadf6b3e3cb2825b093..d8eff72e5b568888b7783074df34f153d25700df 100644 (file)
--- 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 12534839dacf54b920d4fa2f8ffc9a5046e2a456..53a443eae6a1230667b7151dfeb617c10f98be1d 100644 (file)
--- a/doc/help/api-cups.html
+++ b/doc/help/api-cups.html
@@ -1410,13 +1410,13 @@ changed.<br>
 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.<br>
 <br>
-If &quot;num_conflicts&quot; and &quot;conflicts&quot; are not NULL, they are set to contain the
-list of conflicting option/value pairs.  Similarly, if &quot;num_resolved&quot; and
-&quot;resolved&quot; are not NULL they will be set to the list of changes needed to
-resolve the conflict.<br>
+If &quot;num_conflicts&quot; and &quot;conflicts&quot; are not <code>NULL</code>, they are set to
+contain the list of conflicting option/value pairs.  Similarly, if
+&quot;num_resolved&quot; and &quot;resolved&quot; are not <code>NULL</code> they will be set to the
+list of changes needed to resolve the conflict.<br>
 <br>
 If cupsCopyDestConflicts returns 1 but &quot;num_resolved&quot; and &quot;resolved&quot; are set
-to 0 and NULL, respectively, then the conflict cannot be resolved.
+to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved.
 
 </p>
 <h3 class="function"><span class="info">&nbsp;CUPS 1.6/OS X 10.8&nbsp;</span><a name="cupsCopyDestInfo">cupsCopyDestInfo</a></h3>
@@ -1809,14 +1809,13 @@ int cupsGetDestMediaByName (<br>
 <h4 class="returnvalue">Return Value</h4>
 <p class="description">1 on match, 0 on failure</p>
 <h4 class="discussion">Discussion</h4>
-<p class="discussion">The &quot;media&quot; string is a PWG media name, while &quot;width&quot; and &quot;length&quot; are the
-dimensions in hundredths of millimeters.  &quot;flags&quot; provides some matching
+<p class="discussion">The &quot;media&quot; string is a PWG media name.  &quot;Flags&quot; provides some matching
 guidance (multiple flags can be combined):<br>
 <br>
-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 &quot;ready&quot; media.<br>
 <br>
@@ -1859,14 +1858,13 @@ of millimeters</dd>
 <h4 class="returnvalue">Return Value</h4>
 <p class="description">1 on match, 0 on failure</p>
 <h4 class="discussion">Discussion</h4>
-<p class="discussion">The &quot;media&quot; string is a PWG media name, while &quot;width&quot; and &quot;length&quot; are the
-dimensions in hundredths of millimeters.  &quot;flags&quot; provides some matching
-guidance (multiple flags can be combined):<br>
+<p class="discussion">&quot;Width&quot; and &quot;length&quot; are the dimensions in hundredths of millimeters.
+&quot;Flags&quot; provides some matching guidance (multiple flags can be combined):<br>
 <br>
-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 &quot;ready&quot; media.<br>
 <br>