/ 
OODoc-3.01
River stage zero No dependents
/ OODoc::Export::JSON

NAME

OODoc::Export::JSON - Dump the parsed docs into JSON

INHERITANCE

OODoc::Export::JSON
  is an OODoc::Export
  is an OODoc::Object

SYNOPSIS

my $doc = OODoc->new(...);
$doc->export('json');

my $exporter = OODoc::Export::JSON->new;

DESCRIPTION

Create a JSON dump or the parsed documentation, useful to work with dynamically generated web-pages.

Extends "DESCRIPTION" in OODoc::Export.

OVERLOADED

Extends "OVERLOADED" in OODoc::Export.

overload: '==' and '!=' (numeric comparison)

Inherited, see "OVERLOADED" in OODoc::Object

overload: 'bool'

Inherited, see "OVERLOADED" in OODoc::Object

METHODS

Extends "METHODS" in OODoc::Export.

Constructors

Extends "Constructors" in OODoc::Export.

$class->new(%options)

Inherited, see "Constructors" in OODoc::Object

-Option    --Defined in     --Default
 markup      OODoc::Export    <required>
 serializer  OODoc::Export    'json'
markup => $markup
serializer => $name

Attributes

Extends "Attributes" in OODoc::Export.

$obj->unique()

Inherited, see "Attributes" in OODoc::Object

Manual Repository

Extends "Manual Repository" in OODoc::Export.

$obj->addManual($manual)

Inherited, see "Manual Repository" in OODoc::Object

$obj->findManual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->mainManual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->manuals()

Inherited, see "Manual Repository" in OODoc::Object

$obj->manualsForPackage($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->packageNames()

Inherited, see "Manual Repository" in OODoc::Object

$obj->publicationIndex()

Inherited, see "Manual Repository" in OODoc::Object

$obj->publish(\%options)

Inherited, see "Manual Repository" in OODoc::Object

Commonly used functions

Extends "Commonly used functions" in OODoc::Export.

$any->filenameToPackage($filename)

Inherited, see "Commonly used functions" in OODoc::Object

$any->mkdirhier($directory)

Inherited, see "Commonly used functions" in OODoc::Object

Atributes

Extends "Atributes" in OODoc::Export.

$obj->format()

Inherited, see "Atributes" in OODoc::Export

$obj->markupStyle()

Inherited, see "Atributes" in OODoc::Export

$obj->parser()

Inherited, see "Atributes" in OODoc::Export

$obj->serializer()

Inherited, see "Atributes" in OODoc::Export

Output

Extends "Output" in OODoc::Export.

$obj->boolean(BOOL)

Inherited, see "Output" in OODoc::Export

$obj->markup(STRING)

Inherited, see "Output" in OODoc::Export

$obj->markupBlock($text, %args)

Inherited, see "Output" in OODoc::Export

$obj->markupString($string, %args)

Inherited, see "Output" in OODoc::Export

$obj->podChapters($pod)

Inherited, see "Output" in OODoc::Export

$obj->processingManual($manual|undef)

Inherited, see "Output" in OODoc::Export

$obj->tree($doc, %options)

Inherited, see "Output" in OODoc::Export

$obj->write($filename|$filehandle, $publish, %options)

Serialize the collected publishable data to the file.

-Option      --Default
 pretty_print  false
pretty_print => BOOLEAN

Produce readible output.

DETAILS

Extends "DETAILS" in OODoc::Export.

DIAGNOSTICS

Error: Cannot write output to '$file': $!

Error: Write errors to {file}: $!

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

SEE ALSO

This module is part of OODoc version 3.01, built on August 14, 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.