NAME

PLS::Parser::Pod

DESCRIPTION

This class finds and parses POD for an element. It formats the POD into markdown suitable for sending to the Language Server Protocol.

line_number

The line number of the element

column_number

The column number of the element

name

The name of the element.

get_perldoc_location

Tries to find the path to the perldoc utility.

run_perldoc_command

Runs a perldoc command and returns the text formatted into markdown.

get_markdown_for_package

Finds the POD for a package and returns its POD, formatted into markdown.

get_markdown_from_lines

This formats POD from an array of lines into markdown and fixes up improperly formatted text.

get_markdown_from_text

This formats POD from SCALAR ref to a string into markdown and fixes up improperly formatted text.

clean_markdown

This fixes markdown so that documentation isn't incorrectly displayed as code.

combine_markdown

This combines multiple markdown sections into a single string.

get_clean_inc

Starts a new perl process and retrieves its @INC, so we do not use an @INC tainted with things included in PLS.