README

NAME

RakupodObject - Provides a routine to extract the '$=pod' object from an external Rakupod source

SYNOPSIS

use RakupodObject;

DESCRIPTION

RakupodObject is a module that enables easy access to the Rakupod object represented by the Raku variable $=pod. That variable holds the compiled Rakupod tree in a Raku source file. It is used by external programs whose purpose is to process the Rakupod into other objects, primarily other forms of documentation.

The module exports two multi subroutines.

  • multi sub extract-rakupod-object(IO::Path:D $pod-file) is export {...}

  • multi sub extract-rakupod-object(Str:D $pod-string) is export {...}

Credits

The author is indebted to the Raku expert Vadim Belman (AKA @vrurg) who provided the routine during the construction of some Rakupod tests several years ago. The routine, in its original form, can be seen in file https://github.com/raku/roast/blob/master/S26-documentation/12-non-breaking-space.t.

AUTHOR

Tom Browder [email protected]

COPYRIGHT AND LICENSE

Ā© 2022 Tom Browder

This library is free software; you may redistribute it or modify it under the Artistic License 2.0.

RakupodObject v0.0.1

Provides a routine to extract the '$=pod' object from an external Rakupod source

Authors

  • Tom Browder

License

Artistic-2.0

Dependencies

Test Dependencies

Provides

  • RakupodObject

The Camelia image is copyright 2009 by Larry Wall. "Raku" is trademark of the Yet Another Society. All rights reserved.