Python.pm

Go to the documentation of this file.

##############################################################################
# @file  DoxyFilter/Python.pm
# @brief Doxygen filter for Python.
#
# This filter simply converts doc string comments to Doxygen-style
# comments in order to allow the use of Doxygen tags within the
# doc strings which are otherwise ignored by Doxygen.
#
# Copyright (c) 2012 University of Pennsylvania. All rights reserved.
# See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.
#
# Contact: SBIA Group <sbia-software at uphs.upenn.edu>
#
# @ingroup BasisTools
##############################################################################

package BASIS::DoxyFilter::Python;
use base BASIS::DoxyFilter;

# ============================================================================
# states
# ============================================================================

use constant {
    MAIN     => 0,
    FUNCTION => 1,
    CLASS    => 2,
    METHOD   => 3
};

# ============================================================================
# transitions
# ============================================================================

use constant TRANSITIONS => [
];

# ============================================================================
# public
# ============================================================================

# ----------------------------------------------------------------------------
## @brief Constructs a Python Doxygen filter.
sub new
{
    shift->SUPER::new(MAIN, TRANSITIONS);
}


1;