Project

General

Profile

« Previous | Next » 

Revision 828a0c8c

Added by Andreas Kohlbecker almost 4 years ago

code cleaning and adding missing doc

View differences:

modules/cdm_dataportal/includes/name.inc
216 216
 *  );
217 217
 * @endcode
218 218
 *
219
 * @param object $taxonNameType
220
 *    A cdm TaxonNameType entity
221
 *
219 222
 */
220 223
function get_partDefinition($taxonNameType) {
221 224

  
......
569 572
 *    A CDM Taxon instance
570 573
 * @return String
571 574
 *    The string of homomyns
572
 *
573
 * @throws \Exception
574 575
 */
575 576
function cdm_name_relationships_of($taxon) {
576 577

  
modules/cdm_dataportal/theme/cdm_dataportal.page.theme
22 22
 *   - taxon: The taxon name being formatted for the title.
23 23
 *   - uuid: UUID for the taxon.
24 24
 *
25
 * @return string
26
 *  Markup for a taxon page title
27
 *
25 28
 * @ingroup themeable
26 29
 */
27 30
function theme_cdm_taxon_page_title($variables) {
......
47 50
 *   An associative array containing:
48 51
 *   - specimen: The specimen being formatted for the title.
49 52
 *
53
 * @return string
54
 *  Markup for the title of a specimen page
55
 *
50 56
 * @ingroup themeable
51 57
 */
52 58
function theme_cdm_specimen_page_title($variables) {
59

  
53 60
    $specimen = $variables['specimen'];
54 61
    RenderHints::pushToRenderStack('specimen_page_title');
55 62
    $referenceUri = '';
56 63
    $out = '';
57 64

  
58

  
65
    $collection = null;
59 66
    if($specimen->collection->code){
60 67
      $collection = $specimen->collection->code;
61 68
    }
......
96 103
 *   An associative array containing:
97 104
 *   - taxon_name: The taxon name object.
98 105
 *
106
 * @return string
107
 *  Markup for the title of a name page
108
 *
99 109
 * @ingroup themeable
100 110
 */
101 111
function theme_cdm_name_page_title($variables) {
......
115 125
}
116 126

  
117 127

  
118

  
119

  
120

  
121 128
/**
122 129
 * Returns HTML containing the synonymy for the accepted taxon.
123 130
 *
......
130 137
 *   - taxon
131 138
 *   - addAcceptedTaxon
132 139
 *
140
 * @return string
141
 *  Markup for the synonymy
142
 *
143
 * @throws Exception
144
 *
133 145
 * @ingroup themeable
134 146
 */
135 147
function theme_cdm_taxon_page_synonymy($variables) {
......
228 240
 *   - path: The target path for the pager links, this will usually point to
229 241
 *     'cdm_dataportal/search/results/taxon'
230 242
 *
243
 * @return string
244
 *  Markup for the result page
245
 *
246
 * @throws Exception
247
 *
231 248
 * @ingroup themeable
232 249
 */
233 250
function theme_cdm_search_taxa_results($variables)
......
302 319
/**
303 320
 * TODO Implementation of Hook taxon_image_gallery()
304 321
 *
305
 * @param unknown_type $taxon
306
 * @param unknown_type $media
322
 * @param object $taxon
323
 * @param object $media
307 324
 *
308
 * @return unknown_type
325
 * @return string
326
 *  Markup for the default media gallery
309 327
 */
310 328
function taxon_image_gallery_default($taxon, $media) {
311 329
  $hasImages = isset($media[0]);
......
362 380
/**
363 381
 * TODO Implementation of Hook taxon_image_gallery()
364 382
 *
365
 * @param unknown_type $taxon
366
 * @param unknown_type $media
383
 * @param object $taxon
384
 * @param object $media
385
 *
386
 * @return string
387
 *  Markup for the fsi media gallery
367 388
 *
368
 * @return unknown_type
389
 * @throws Exception
369 390
 */
370 391
function taxon_image_gallery_fsi($taxon, $media) {
371 392
  $flashLink = isset($media[0]);
......
397 418
 *
398 419
 * @return array
399 420
 *  A drupal render array
421
 * 
422
 * @throws Exception
400 423
 *
401 424
 * @ingroup compose
402 425
 */

Also available in: Unified diff