CodeTag.codeMatch typedef

Checks if CodeTag.code of the same CodeTag instance can/should handle a passed CodeLine.

function(codeLine)

Parameters

  1. codeLine {CodeLine}:

    String of characters until newline.

Returns

{Boolean}:

Whether or not CodeTag.code can handle the passed CodeLine.

Use

The bit-docs-js/process/code processor consecutively passes any one CodeLine that immediately follows a CodeTagBlock to every CodeTag's CodeTag.codeMatch function until one or none returns true.

The first CodeTag whose CodeTag.codeMatch returns true will be used by the bit-docs-js/process/code processor to handle the passed CodeLine using CodeTag.code.