backdrop-contrib / examples

Examples for Developers
GNU General Public License v2.0
7 stars 9 forks source link

Fix the @link markup #101

Closed avpaderno closed 7 months ago

avpaderno commented 8 months ago

In some cases, the @link tag does not include a matching @endlink tag.

/**
 * See @link ajax_example_advanced.inc AJAX Advanced Commands for more details
 * on AJAX framework commands.
 */

In other cases, a link is used when a group name could be instead used.

/**
 * See @link https://docs.backdropcms.org/api/backdrop/core%21modules%21file%21file.module/group/file-module-api/1 File module public API functions @endlink
 */

Furthermore, as reported on Code Documentation Standards, there is no need to use @link/@endlink to make a link if the link text would be the same as the function name, class name, or file name.

Those need to be fixed/changed.