Code Index:

package Sub::Todo
__END__
EOF

NAME

Sub::Todo - mark subroutines or methods as 'TODO'

VERSION

This document describes Sub::Todo version 0.0.3

SYNOPSIS

    use Sub::Todo;

    sub foo {
	    return 'foo';
    }

    sub bar {
	    goto &todo; 
    }

    *baz = \&todo_croak;

Then in your app:

   bar() or die "bar() failed: $!";  
   baz();

Which reminds you "oh yeah, we need to do this still"

DESCRIPTION

At times you want to/need to/should write the flow of logic without having to break to create the actual functions or methods being used. You can create them as temporary 'TODO's by goto()ing any of these 'todo' utilities (see INTERFACE).

EXPORT

todo() is exported by default, the rest can be exported, ':all' will export them all, ':long' will export the "long" disambiguously named functions.

INTERFACE

These are made to be used with goto() (see SYNOPSIS). They set $! and 'return;'

todo()

set $! and return

todo_return()

Same as todo() but the name is more descriptive

todo_carp()

Same as todo() but it additionally 'carp $!;'

todo_croak()

Same as todo() but it additionally 'croak $!;'

get_errno_func_not_impl()

This is used internally to set $!.

It should determine the correct value from POSIX if you've used POSIX, based on the OS name, or a semi-safe default.

DIAGNOSTICS

Throws no real errors or warnings of its own. Except todo_carp() and todo_croak() which throw $!

If $! is not 'Function not implemented' please open an rt with this information:

* The output of this command:

  perl -MPOSIX -le 'print "-$^O-";print "-" . POSIX::ENOSYS . "-"';

* Does adding 'use POSIX;' get $! set properly?

CONFIGURATION AND ENVIRONMENT

Sub::Todo requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-sub-todo@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Daniel Muey <http://drmuey.com/cpan_contact.pl>

LICENCE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.