From 280243ea65a05eb70dfafd780f1397d2320fa4b3 Mon Sep 17 00:00:00 2001 From: Adam Vessey Date: Wed, 11 Apr 2012 17:10:19 -0300 Subject: [PATCH] Drupal-parsable docs --- api/fedora_item.inc | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/api/fedora_item.inc b/api/fedora_item.inc index b647e514..1063262d 100644 --- a/api/fedora_item.inc +++ b/api/fedora_item.inc @@ -879,17 +879,25 @@ RDF; } /** + * Wrap modify by value and reference + * * Wrap modify by value and reference, so that the proper one gets called in the correct instance. (value if inline XML, reference otherwise) * * First tries to treat the passed in value as a filename, tries using as contents second. * Coerces the data into what is required, and passes it on to the relevant function. * - * @param $filename_or_content Either a filename to add, or an string of content. - * @param $dsid The DSID to update - * @param $label A label to withwhich to update the datastream - * @param $mime_type Mimetype for the data being pushed into the datastream - * @param $force Dunno, refer to underlying functions/SOAP interface. We just pass it like a chump. - * @param $logMessage A message for the audit log. + * @param string $filename_or_content + * Either a filename to add, or an string of content. + * @param string $dsid + * The DSID to update + * @param string $label + * A label to withwhich to update the datastream + * @param string $mime_type + * Mimetype for the data being pushed into the datastream + * @param boolean $force + * Dunno, refer to underlying functions/SOAP interface. We just pass it like a chump. + * @param string $logMessage + * A message for the audit log. */ function modify_datastream($filename_or_content, $dsid, $label, $mime_type, $force = FALSE, $logMessage='Modified by Islandora API') { //Determine if it's inline xml; if it is, modify by value