EnsEMBL::PerlFilter Class Reference

Public Member Functions
public	filter ()
public	normal_parser ()
public	normal_action ()
public	inheritance_parser ()
public	inheritance_action ()
public	pod_top_parser ()
public	pod_top_action ()
	if (defined($header) &&( $header eq "DESCRIPTION"|| $header eq "SYNOPSIS"))
	elsif (defined($header) && $header eq "SEE ALSO")
	elsif (not defined($header))
endcode</div > *public	pod_section_parser ()
public	pod_section_action ()
public	pod_method_parser ()
public	pod_method_action ()
public	see_also_parser ()
public	see_also_action ()
public	finish ()
public	code_parser ()
push	$method_description ()
endcode</div > *public	code_action ()
public	sanitize_return_values ()

Public Attributes
	n
	buffer = ()
	else
push	big_buffer

Detailed Description

Description

  Implementation of EnsEMBL::PerlFilter.
  Derived from http://www.bigsister.ch/doxygenfilter by Bart Schuller and Thomas Aeby
  Original distributed under Perl artistic license, see: http://www.bigsister.ch/doxygenfilter/license.html

  Adaptations by Kieron Taylor (ktaylor\@ebi.ac.uk), 2011

  State Machine rewrite of existing filter.
  Was going to use DFA::Command to handle the logic, but actually it won't work well for parsing Perl, 
  hence own simplified state machine. Intentionally not using PPI package to parse Perl, too complex.
  This is a 80/20 EnsEMBL specific POD->Doxygen converter, however it should work somewhat with other code.
 

Definition at line 18 of file PerlFilter.pm.

Member Function Documentation

$method_description()

push EnsEMBL::PerlFilter::$method_description

(

)

code_action()

public EnsEMBL::PerlFilter::code_action

(

)

Undocumented method

Code:

code_parser()

public EnsEMBL::PerlFilter::code_parser

(

)

Undocumented method

Code:

elsif() [1/2]

EnsEMBL::PerlFilter::elsif ( defined($header) && $header eq "SEE ALSO"  )

inline

Definition at line 344 of file PerlFilter.pm.

elsif() [2/2]

EnsEMBL::PerlFilter::elsif ( not   defined $header )

inline

Definition at line 347 of file PerlFilter.pm.

filter()

public EnsEMBL::PerlFilter::filter

(

)

Undocumented method

Code:

finish()

public EnsEMBL::PerlFilter::finish

(

)

Undocumented method

Code:

if()

EnsEMBL::PerlFilter::if ( defined( $header) &&($header eq "DESCRIPTION"||$header eq "SYNOPSIS")  )

inline

Definition at line 341 of file PerlFilter.pm.

inheritance_action()

public EnsEMBL::PerlFilter::inheritance_action

(

)

Undocumented method

Code:

inheritance_parser()

public EnsEMBL::PerlFilter::inheritance_parser

(

)

Undocumented method

Code:

normal_action()

public EnsEMBL::PerlFilter::normal_action

(

)

Undocumented method

Code:

normal_parser()

public EnsEMBL::PerlFilter::normal_parser

(

)

Undocumented method

Code:

pod_method_action()

public EnsEMBL::PerlFilter::pod_method_action

(

)

Undocumented method

Code:

pod_method_parser()

public EnsEMBL::PerlFilter::pod_method_parser

(

)

Undocumented method

Code:

}

pod_section_action()

public EnsEMBL::PerlFilter::pod_section_action

(

)

Undocumented method

Code:

pod_section_parser()

public EnsEMBL::PerlFilter::pod_section_parser

(

)

Undocumented method

Code:

pod_top_action()

public EnsEMBL::PerlFilter::pod_top_action

(

)

Undocumented method

Code:

pod_top_parser()

public EnsEMBL::PerlFilter::pod_top_parser

(

)

Undocumented method

Code:

sanitize_return_values()

public EnsEMBL::PerlFilter::sanitize_return_values

(

)

Undocumented method

Code:

see_also_action()

public EnsEMBL::PerlFilter::see_also_action

(

)

Undocumented method

Code:

see_also_parser()

public EnsEMBL::PerlFilter::see_also_parser

(

)

Undocumented method

Code:

Member Data Documentation

big_buffer

push EnsEMBL::PerlFilter::big_buffer

Definition at line 599 of file PerlFilter.pm.

buffer

EnsEMBL::PerlFilter::buffer = ()

Definition at line 339 of file PerlFilter.pm.

else

EnsEMBL::PerlFilter::else

Initial value:

{
            $state = PODTOP

Definition at line 350 of file PerlFilter.pm.

n

EnsEMBL::PerlFilter::n

Definition at line 338 of file PerlFilter.pm.

---

The documentation for this class was generated from the following file:

• ensembl/misc-scripts/doxygen_filter/EnsEMBL/PerlFilter.pm