/ 
OODoc-0.93
River stage zero No dependents
/ OODoc::Text::Diagnostic

NAME

OODoc::Text::Diagnostic - one explanation of a problem report

INHERITANCE

OODoc::Text::Diagnostic
  is an OODoc::Text
  is an OODoc::Object

SYNOPSIS

DESCRIPTION

Each OODoc::Text::Subroutine can have a list of warning and error messages, which are each captured in a separate object as described in this manual page.

OVERLOADED

overload: '""' (stringification)

overload: '==' and '!='

overload: 'cmp' (string comparison)

METHODS

Constructors

OODoc::Text::Diagnostic->new(OPTIONS)

    -Option --Defined in --Default container OODoc::Text new(subroutine) description OODoc::Text '' linenr OODoc::Text <required> name OODoc::Text undef subroutine <required> type OODoc::Text 'Diagnostic'

    . container OBJECT

    . description STRING

    . linenr INTEGER

    . name STRING

    . subroutine OBJECT

      The subroutine in which this option lives.

    . type STRING

Inheritance knowledge

$obj->extends([OBJECT])

Attributes

$obj->container([OBJECT])

$obj->description

$obj->name

$obj->subroutine

    Returns the subroutine object for this option.

$obj->type

Location

$obj->manual([NAME])

$obj->unique

$obj->where

Collected

$obj->example(OBJECT)

$obj->examples

$obj->findDescriptionObject

$obj->openDescription

Commonly used functions

$obj->filenameToPackage(FILENAME)

OODoc::Text::Diagnostic->filenameToPackage(FILENAME)

$obj->mkdirhier(DIRECTORY)

OODoc::Text::Diagnostic->mkdirhier(DIRECTORY)

Manual Repository

$obj->addManual(MANUAL)

$obj->mainManual(NAME)

$obj->manuals

$obj->manualsForPackage(NAME)

$obj->packageNames

DIAGNOSTICS

Error: manual definition requires manual object

A call to addManual() expects a new manual object (a OODoc::Manual), however an incompatible thing was passed. Usually, intended was a call to manualsForPackage() or mainManual().

REFERENCES

See the OODoc website at http://perl.overmeer.net/oodoc/ for more details.

COPYRIGHTS

Module version 0.93. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2003-2006 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.