summaryrefslogtreecommitdiff
path: root/mg.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2014-06-05 14:22:50 -0600
committerKarl Williamson <khw@cpan.org>2014-06-05 15:22:30 -0600
commit7fefc6c1fed0a352d7bf8df209df5274d6cd8fb0 (patch)
tree11ad6b9cf1fa968e8c18f69d040490bd55c8b747 /mg.c
parent9d9a81f09abfecc51243ec21a51eea7fb0e6b9bc (diff)
downloadperl-7fefc6c1fed0a352d7bf8df209df5274d6cd8fb0.tar.gz
perlapi: Include general information
Unlike other pod handling routines, autodoc requires the line following an =head1 to be non-empty for its text to be included in the paragraph started by the heading. If you fail to do this, silently the text will be omitted from perlapi. I went through the source code, and where it was apparent that the text was supposed to be in perlapi, deleted the empty line so it would be, with some revisions to make more sense. I added =cuts where I thought it best for the text to not be included.
Diffstat (limited to 'mg.c')
-rw-r--r--mg.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/mg.c b/mg.c
index e62e9e6c9b..cf0d323f81 100644
--- a/mg.c
+++ b/mg.c
@@ -17,7 +17,6 @@
/*
=head1 Magical Functions
-
"Magic" is special data attached to SV structures in order to give them
"magical" properties. When any Perl code tries to read from, or assign to,
an SV marked as magical, it calls the 'get' or 'set' function associated
@@ -35,6 +34,8 @@ plus space for some flags and pointers. For example, a tied variable has
a MAGIC structure that contains a pointer to the object associated with the
tie.
+=cut
+
*/
#include "EXTERN.h"