NAME

OODoc::Index - administer the collected information

INHERITANCE

OODoc::Index
  is an OODoc::Object

SYNOPSIS

my $index = $oodoc->index;

DESCRIPTION

Extends "DESCRIPTION" in OODoc::Object.

OVERLOADED

#--------------------

Extends "OVERLOADED" in OODoc::Object.

overload: '!=' (numeric different)

Inherited, see "OVERLOADED" in OODoc::Object

overload: '==' (numeric equivalent)

Inherited, see "OVERLOADED" in OODoc::Object

overload: 'bool'

Inherited, see "OVERLOADED" in OODoc::Object

METHODS

Extends "METHODS" in OODoc::Object.

Constructors

Extends "Constructors" in OODoc::Object.

$class->new(%options)

Inherited, see "Constructors" in OODoc::Object

Attributes

Extends "Attributes" in OODoc::Object.

$obj->publish(\%options)

Inherited, see "Attributes" in OODoc::Object

$obj->unique()

Inherited, see "Attributes" in OODoc::Object

The Manual Repository

$obj->addManual($manual)

The $manual will be added to the list of known manuals. The same package name can appear in more than one manual. This OBJECT shall be of type OODoc::Manual.

$obj->findManual($name)

[3.00] Returns the manual with the specified name, or else undef.

$obj->mainManual($name)

Returns the manual of the named package which contains the primar documentation for the code of the package $name.

$obj->manuals()

All manuals are returned.

$obj->manualsForPackage($name)

Returns a list package objects which are related to the specified $name. One $name can appear in more than one file, and therefore a list is returned.

$obj->packageNames()

Returns the names of all defined packages.

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(). Cast by addManual()

SEE ALSO

This module is part of OODoc version 3.03, built on September 08, 2025. Website: https://perl.overmeer.net/oodoc/

LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2003-2025 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.