otcldoc(1) [debian man page]

otcldoc(1)							   User Manuals 							otcldoc(1)

NAME

       otcldoc - simple script for translating otcl classes into an html hyperlinked document

SYNOPSIS

       otcldoc [-h index-header-file] [ -d output-dir ] [ -i index-file-name ] [ -c class-string ] files ...

DESCRIPTION

       otcldoc simple script for translating otcl classes into an html hyperlinked document.  Inspired by javadoc.

       Basic  algorithm:  for a given set of input files, find all Class definitions.  Put the text in the comment immediately preceding the class
       def in the "description" section of the doc.  Parse the Class definition to locate superclasses and at that to the "superclasses"  section.
       Locate each method labeled as instproc, public, or private, and enter desriptions in the "Public/Private Methods" sections of the html doc.

AUTHOR

       YunQiang Su <wzssyqa@gmail.com>

SEE ALSO

Linux								    APRIL 2010								otcldoc(1)

Mouse::Meta::Class(3pm) 				User Contributed Perl Documentation				   Mouse::Meta::Class(3pm)

NAME

       Mouse::Meta::Class - The Mouse class metaclass

VERSION

       This document describes Mouse version 0.99

DESCRIPTION

       This class is a meta object protocol for Mouse classes, which is a subset of Moose::Meta:::Class.

METHODS

   "initialize(ClassName) -> Mouse::Meta::Class"
       Finds or creates a "Mouse::Meta::Class" instance for the given ClassName. Only one instance should exist for a given class.

   "name -> ClassName"
       Returns the name of the owner class.

   "superclasses -> ClassNames" "superclass(ClassNames)"
       Gets (or sets) the list of superclasses of the owner class.

   "add_method(name => CodeRef)"
       Adds a method to the owner class.

   "has_method(name) -> Bool"
       Returns whether we have a method with the given name.

   "get_method(name) -> Mouse::Meta::Method | undef"
       Returns a Mouse::Meta::Method with the given name.

       Note that you can also use "$metaclass->name->can($name)" for a method body.

   "get_method_list -> Names"
       Returns a list of method names which are defined in the local class.  If you want a list of all applicable methods for a class, use the
       "get_all_methods" method.

   "get_all_methods -> (Mouse::Meta::Method)"
       Return the list of all Mouse::Meta::Method instances associated with the class and its superclasses.

   "add_attribute(name => spec | Mouse::Meta::Attribute)"
       Begins keeping track of the existing Mouse::Meta::Attribute for the owner class.

   "has_attribute(Name) -> Bool"
       Returns whether we have a Mouse::Meta::Attribute with the given name.

   "get_attribute Name -> Mouse::Meta::Attribute | undef"
       Returns the Mouse::Meta::Attribute with the given name.

   "get_attribute_list -> Names"
       Returns a list of attribute names which are defined in the local class. If you want a list of all applicable attributes for a class, use
       the "get_all_attributes" method.

   "get_all_attributes -> (Mouse::Meta::Attribute)"
       Returns the list of all Mouse::Meta::Attribute instances associated with this class and its superclasses.

   "linearized_isa -> [ClassNames]"
       Returns the list of classes in method dispatch order, with duplicates removed.

   "new_object(Parameters) -> Instance"
       Creates a new instance.

   "clone_object(Instance, Parameters) -> Instance"
       Clones the given instance which must be an instance governed by this metaclass.

   "throw_error(Message, Parameters)"
       Throws an error with the given message.

SEE ALSO

       Mouse::Meta::Module

       Moose::Meta::Class

       Class::MOP::Class

perl v5.14.2							    2012-06-30						   Mouse::Meta::Class(3pm)