Improve formatting of return values

[klonos]

In code:

/**
 * Legacy wrapper to return the vocabulary object matching a vocabulary machine
 * name.
 *
 * @param $machine_name
 *   The vocabulary's machine name.
 *
 * @return TaxonomyVocabulary|false
 *   The taxonomy vocabulary, if it exists, FALSE otherwise. Results are
 *   statically cached.
 *
 * @see taxonomy_vocabulary_machine_name_load()
 */
function taxonomy_vocabulary_load($machine_name) {
  $vocabularies = taxonomy_vocabulary_load_multiple(array($machine_name));
  return reset($vocabularies);
}

How this gets rendered:

...there should be a line break there, or some other sort of separation between TaxonomyVocabulary|false and the rest of the sentence.

[klonos]

...perhaps bold the return value, and add a column after it (same as we do with params)? So that it is rendered like so instead:

[ghost]

Working on this...

[ghost]

PR made to API module that addresses this.

As mentioned in the PR, this does a weird thing with @return tags with no following data type indicator (bolding the first line of the documentation instead), but I see this as a bug with the @return tags, not the regex here...

[jenlampton]

@BWPanda I applied your patch to the API module, but I'm not seeing a line-break on the taxonomy_vocabulary_load() page.

edit: oh, duh. I bet it needs to re-scan the files first... maybe I do that by running cron? Aha! I found the "reparse" button :) I'll leave this issue open until we can confirm this fix is working, but I expect it's just a matter of time now.

[ghost]

This is working (https://docs.backdropcms.org/api/backdrop/core%21modules%21taxonomy%21taxonomy.module/function/taxonomy_vocabulary_load/1), so we can close.