NAME

Perinci::Manual::HowTo::FunctionMetadata - How-to guides related to function metadata

VERSION

This document describes version 0.007 of Perinci::Manual::HowTo::FunctionMetadata (from Perl distribution Perinci-Manual), released on 2021-07-31.

HIDING ARGUMENT

To make an argument "hidden", you can add either a hidden, hidden-cli, or hidden-mod to the tags property. This will have the following effects:

• Perinci::To::POD (as well as its sisters like Perinci::To::Text, Perinci::To::HTML) will not list the argument in the generated documentation

  This is for hidden or hidden-mod tag.

• Perinci::Sub::To::CLIDocData (which is used by Perinci::CmdLine) will not list the arguments in the CLI documentation as well as --help message

  This is for hidden or hidden-cli tag.

So with hidden-cli or hidden-mod you can hide arguments from CLI-only or module POD only.

HIDING FUNCTION

To make a function "hidden", you can set x.no_index attribute to true, or add a hidden tag to the tags property. This will have the following effects:

• Perinci::To::POD (as well as its sisters like Perinci::To::Text, Perinci::To::HTML) will not list the function in the generated documentation

  If you use the Pod::Weaver plugin Pod::Weaver::Plugin::Rinci, the generated POD documentation for your module will also skip the function, making the function undocumented in the POD.

• Perinci::Access::Schemeless, Perinci::Access::Perl, as well as other Perinci::Access::* modules which uses the former (like Perinci::Access::HTTP::Server) will not list the function

  When you issue a list CRiap request to one of these modules, the function will not be listed in the package it is in.

Keywords: undocumented, documentation

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-Manual.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-Manual.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Manual

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

More specific how-to guides can be found in Perinci::Manual::HowTo::FunctionMetadata::XXX, e.g. Perinci::Manual::HowTo::FunctionMetadata::Examples

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by perlancar@cpan.org.

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