Stack Overflow
Stack Overflow

Questions tagged [perl-pod]

Plain Old Documentation format. Pod is a simple-to-use markup language used for writing documentation for Perl, Perl programs, and Perl modules.

perlpod

63 questions
27
votes
8 answers

What's the best way to document Perl code?

Any suggestion how I can document my Perl code? What do you use and what tools are available to help me? Which module do you use to convert pod to html?
Tomasz
  • 5,269
  • 8
  • 56
  • 65
13
votes
6 answers

Is there really no better way to document perl code than POD?

I'm a Perl programmer for a long time, but I always have problems with documentation in POD. When I use POD comments in the code, the code is difficult to read. When I use POD comments at the end of file, there is the danger that the documentation…
ulli82
  • 155
  • 4
12
votes
1 answer

Why does perldoc evaluate 'Münster' as 'Muenster'

I have a simple POD text file: $ cat test.pod =encoding UTF-8 Münster It is encoded in UTF-8, as per this literal hex dump of the file: 00000000 3d 65 6e 63 6f 64 69 6e 67 20 55 54 46 2d 38 0a |=encoding UTF-8.| 00000010 0a 4d c3 bc 6e 73 74…
Kaoru
  • 1,540
  • 11
  • 14
12
votes
5 answers

Perl documentation (POD) browsers?

I'm looking for is a good on-screen POD reading experience. For years, I've used perldoc or man running in an xterm to read Perl documentation on screen, and a small custom program built around Pod::LaTeX to print it. The printed version is good:…
derobert
  • 49,731
  • 15
  • 94
  • 124
11
votes
4 answers

Is there a WYSIWYG Perl Pod editor?

Is there an easy to use "what-you-see-is-what-you-get" editor for Pod available? I'm not that used to the Pod syntax yet so having the option of writing the Pod and immediatly see what the output would look like will help a lot. Ideally this editor…
Fredrik
  • 10,626
  • 6
  • 45
  • 81
9
votes
2 answers

How can I use Unicode characters in Perl POD-derived man pages?

And if this isn't possible, what is the best practice for dealing with man pages derived from UTF-8-encoded POD? The first thing to do in order to work with Unicode in POD is to use the directive =encoding UTF-8 (as discussed here). The pod2text…
glts
  • 21,808
  • 12
  • 73
  • 94
9
votes
2 answers

How to create POD and use pod2usage in perl?

I want to create a POD for my own custom command and display the syntax for that using pod2usage() function.. Can anyone give me a simple example for it? Regards, Anandan
Anandan
  • 983
  • 3
  • 13
  • 28
8
votes
1 answer

Which Perl module do I use to convert Pod to HTML?

I need to convert Pod to HTML. There are number of Pod::HTML and Pod::Simple::* modules. Which one is the one I should use?
Eric Johnson
  • 17,502
  • 10
  • 52
  • 59
8
votes
3 answers

Online Perl POD renderer

I seem to remember an "offical" site (perl.org or cpan.org) which had a POD previewer. One uploaded a file and it would display the contained POD as it would appear on CPAN. Does someone have this link. I can't seem to find it.
Joel Berger
  • 20,180
  • 5
  • 49
  • 104
8
votes
4 answers

Are there any conventions for writing POD comments for Perl?

I was able to find a page from Safari Books Online that provides a template, but having never written POD comments, I'm not sure how good it is or if it is missing anything that might be considered convention to include. What are the conventions to…
Thomas Owens
  • 114,398
  • 98
  • 311
  • 431
7
votes
4 answers

How can I have link text with a URL in Pod's L<>?

The L formatting code allows you to set the display text for the link if you're linking to other POD, as in L, but this isn't allowed for L links, such as L How do I…
Drew Stephens
  • 17,207
  • 15
  • 66
  • 82
7
votes
2 answers

How can I concisely document methods in Perl code?

I favor a kind-of literal programming style with POD comments next to the code they document. Unfortunately this bloats the code, which is not very Perlish ;-) The best way I could find by now is to use Dist::Zilla with Pod::Weaver like…
Jakob
  • 3,570
  • 3
  • 36
  • 49
6
votes
4 answers

Adding a help command to a script

Is there a standard way of adding a help function to a script? The simplest way would maybe to take an argument and print some text if it's "-help" or something. Does anyone have any examples on how to do this? Thanks!
user1758367
  • 197
  • 1
  • 3
  • 11
6
votes
2 answers

Perl POD coverage for scripts and tests (not modules)

Is there a way to measure POD coverage for scripts (e.g. *.pl)? I can measure documentation coverage for packages using Pod::Coverage and Test::Pod::Coverage, but I cannot measure it for scripts, because Pod::Coverage and the underlying…
battery
  • 511
  • 2
  • 8
6
votes
2 answers

Is it possible to use POD(plain old documentation) with Python?

I was wondering if it is possible to use POD(plain old documentation) with Python? And how should I do it?
user1597836
  • 61
  • 2
1
2 3 4 5