Stas Bekman > DocSet-0.19 > DocSet::DocSet

Download:
DocSet-0.19.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

DocSet::DocSet - An abstract docset generation class

SYNOPSIS ^

  use DocSet::DocSet::HTML ();
  my $docset = DocSet::DocSet::HTML->new($config_file);
  
  # must start from the abs root
  chdir $abs_root;
  
  # must be a relative path to be able to move the generated code from
  # location to location, without adjusting the links
  $docset->set_dir(abs_root => ".");
  $docset->scan;
  $docset->render;

  my $should_update = $self->should_update($src_path, $dst_path);

DESCRIPTION ^

DocSet::DocSet processes a docset, which can include other docsets, documents and links. In the first pass it scans the linked to it documents and other docsets and caches this information and the objects for a later peruse. In the second pass the stored objects are rendered. And the docset is completed.

This class cannot be used on its own and has to be subclassed and extended, by the sub-classes which has a specific to input and output formats of the documents that need to be processed. It handles only the partial functionality which doesn't require format specific knowledge.

METHODS

This class inherits from DocSet::Config and you will find the documentation of methods inherited from this class in its pod.

The following "public" methods are implemented in this super-class:

ABSTRACT METHODS

The following methods should be implemented by the sub-classes.

AUTHORS ^

Stas Bekman <stas (at) stason.org>

syntax highlighting: