The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
OODoc-0.02
River stage zero No dependents
/ OODoc::Text::Diagnostic

NAME

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

INHERITANCE

 OODoc::Text::Diagnostic
   is a OODoc::Text
   is a 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.

METHODS

$obj->subroutine

    Returns the subroutine object for this option.

Attributes

$obj->description

$obj->findDescriptionObject

$obj->openDescription

$obj->type

$obj->where

Container

$obj->container

$obj->manual

Examples

$obj->example(OBJECT)

$obj->examples

Initiation

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

     Option            Defined in       Default     
 additional_rules  OODoc::Parser::Markov  []          
 chapter           OODoc::Text::Section  <required>  
 container         OODoc::Text      <subroutine>
 description       OODoc::Text      ''          
 filename          OODoc::Manifest  C<undef>    
 linenr            OODoc::Text      <required>  
 manual            OODoc::Text::Chapter  <required>  
 module            OODoc            <required>  
 name              OODoc::Text      C<undef>    
 package           OODoc::Manual    <required>  
 parameters        OODoc::Text::Subroutine  C<undef>    
 parser            OODoc::Manual    <required>  
 pure_pod          OODoc::Manual    0           
 section           OODoc::Text::SubSection  <required>  
 source            OODoc::Manual    <required>  
 stripped          OODoc::Manual    C<undef>    
 subroutine                         <required>  
 type              OODoc::Text      <required>  
 value             OODoc::Text::Default  <required>  
 verbose           OODoc            0           
 version           OODoc            <required>  
 workdir           OODoc            C<undef>

    . additional_rules ARRAY

    . chapter OBJECT

    . container OBJECT

    . description STRING

    . filename FILENAME

    . linenr INTEGER

    . manual OBJECT

    . module STRING

    . name STRING

    . package STRING

    . parameters STRING

    . parser OBJECT

    . pure_pod BOOLEAN

    . section OBJECT

    . source STRING

    . stripped STRING

    . subroutine OBJECT

      The subroutine in which this option lives.

    . type STRING

    . value STRING

    . verbose INTEGER

    . version STRING

    . workdir DIRECTORY

Inheritance

$obj->extends([OBJECT])

Commonly used functions

$obj->filenameToPackage(FILENAME)

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

$obj->mergeObjects(OPTIONS)

$obj->mkdirhier(DIRECTORY)

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

$obj->unique

Manual database

All manuals can be reached everywhere in the program: it is a global collection.

$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().

Warning: order conflict "$take" before "$insert" in $file line $number

The order of the objects in a sub-class shall be the same as that of the super class, otherwise the result of merging of the information received from both classes is undertermined.

REFERENCES

See the OODoc website at $website for more details.

COPYRIGHTS

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

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