It's code that is tricking all the POD parsers. See, in your code snippet, there is no POD. POD section are defined as to start with the a '=' (followed by a letter) at the beginning of a line, when perl expects a new statement
. But here, at the moment of =pod
, perl isn't expecting a new statement. In fact, it's busy finding the end of a here document -- whose end is =cut
So, what's happening here is that:
This module uses the following constants:
bang_eth => 1
biff => 2
krunch => 3
is a here document (it starts with a blank line above =pod
, and ends with a blank line), with =cut
as terminator. The rest is just parsing this string.
Why does it appear in the documentation? Because POD parsers actually don't parse POD. They parse anything between ^=\w and ^=cut, without looking at context, assuming to capture all the POD (and nothing but the POD). Most of the time, this heuristic works well, but as with all heuristics, it sometimes will break down, and someone will (a)buse it.