Skip to content

Commit 91f0402

Browse files
committed
perl.h - break up * lined comment leaders and pod comments
Having half of the comment have the * on the left side is confusing for humans and especially so for programs. Split the two style into two comments.
1 parent 361ae85 commit 91f0402

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

pad.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,9 @@ typedef enum {
161161

162162
/* Note: the following three macros are actually defined in scope.h, but
163163
* they are documented here for completeness, since they directly or
164-
* indirectly affect pads.
164+
* indirectly affect pads. */
165165

166+
/*
166167
=for apidoc m|void|SAVEPADSV |PADOFFSET po
167168
Save a pad slot (used to restore after an iteration)
168169

perl.h

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,9 @@ Now a no-op.
457457
* marking unused variables (they need e.g. a #pragma) and therefore
458458
* cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
459459
* if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
460+
*/
460461

462+
/*
461463
=for apidoc_section $directives
462464
=for apidoc AmnU||PERL_UNUSED_DECL
463465
Tells the compiler that the parameter in the function prototype just before it
@@ -476,7 +478,7 @@ Example usage:
476478
=back
477479
478480
=cut
479-
*/
481+
*/
480482

481483
#ifndef PERL_UNUSED_DECL
482484
# define PERL_UNUSED_DECL __attribute__unused__
@@ -486,7 +488,8 @@ Example usage:
486488
* for silencing unused variables that are actually used most of the time,
487489
* but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs,
488490
* or variables/arguments that are used only in certain configurations.
489-
491+
*/
492+
/*
490493
=for apidoc Am;||PERL_UNUSED_ARG|void x
491494
This is used to suppress compiler warnings that a parameter to a function is
492495
not used. This situation can arise, for example, when a parameter is needed
@@ -504,7 +507,7 @@ This situation can arise, for example, when a C preprocessor conditional
504507
compilation causes it be used just some times.
505508
506509
=cut
507-
*/
510+
*/
508511
#ifndef PERL_UNUSED_ARG
509512
# define PERL_UNUSED_ARG(x) ((void)sizeof(x))
510513
#endif
@@ -1379,7 +1382,9 @@ EXTERN_C int usleep(unsigned int);
13791382

13801383
/* Macros for correct constant construction. These are in C99 <stdint.h>
13811384
* (so they will not be available in strict C89 mode), but they are nice, so
1382-
* let's define them if necessary.
1385+
* let's define them if necessary. */
1386+
1387+
/*
13831388
=for apidoc_section $integer
13841389
=for apidoc Am|I16|INT16_C|number
13851390
=for apidoc_item |I32|INT32_C|number

0 commit comments

Comments
 (0)