Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed several perldoc rendering issues and added a few "SEE ALSO" sec…

…tions
  • Loading branch information...
commit 4b296a2fcc21acf274f9a1b570d44057cf9bd762 1 parent 9411d47
@soh-cah-toa soh-cah-toa authored
View
12 src/global_setup.c
@@ -268,6 +268,18 @@ Parrot_gbl_setup_2(PARROT_INTERP)
}
/*
+
+=back
+
+=head1 SEE ALSO
+
+F<include/parrot/global_setup.h>
+
+=cut
+
+*/
+
+/*
* Local variables:
* c-file-style: "parrot"
* End:
View
4 src/hash.c
@@ -303,6 +303,8 @@ hash_compare_string(PARROT_INTERP, ARGIN(const void *search_key), ARGIN(const vo
Compare two strings. Returns 0 if they are identical. Considers differing
encodings to be distinct.
+=cut
+
*/
PARROT_WARN_UNUSED_RESULT
@@ -2215,7 +2217,7 @@ Parrot_hash_value_to_number(PARROT_INTERP, ARGIN(const Hash *hash), ARGIN_NULLOK
=head1 SEE ALSO
-F<docs/pdds/pdd08_keys.pod>.
+F<docs/pdds/draft/pdd08_keys.pod>, F<include/parrot/hash.h>
=head1 TODO
View
5 src/hll.c
@@ -477,8 +477,11 @@ Parrot_hll_regenerate_HLL_namespaces(PARROT_INTERP)
Leopold Toetsch
-=cut
+=head1 SEE ALSO
+
+F<include/parrot/hll.h>
+=cut
*/
View
4 src/list.c
@@ -233,6 +233,10 @@ Parrot_list_contains(SHIM_INTERP,
=back
+=head1 SEE ALSO
+
+F<include/parrot/list.h>
+
=cut
*/
View
2  src/longopt.c
@@ -307,7 +307,7 @@ longopt_get_shortopt(int argc, ARGIN(const char* argv[]),
=head1 SEE ALSO
-F<include/parrot/longopt.h> and F<docs/dev/longopt.dev>.
+F<include/parrot/longopt.h>, F<docs/dev/longopt.pod>
=cut
View
2  src/misc.c
@@ -278,7 +278,7 @@ Parrot_secret_snprintf(ARGOUT(char *buffer), SHIM(size_t len), ARGIN(const char
=head1 SEE ALSO
-F<src/misc.h>, F<src/spf_vtable.c>, F<src/spf_render.c>.
+F<src/spf_vtable.c>, F<src/spf_render.c>, F<include/parrot/misc.h>
=head1 HISTORY
View
4 src/multidispatch.c
@@ -1348,8 +1348,8 @@ Parrot_mmd_cache_mark(PARROT_INTERP, ARGMOD(MMD_Cache *cache))
=head1 SEE ALSO
F<include/parrot/multidispatch.h>,
-F<http://svn.perl.org/perl6/doc/trunk/design/apo/A12.pod>,
-F<http://svn.perl.org/perl6/doc/trunk/design/syn/S12.pod>
+L<http://svn.perl.org/perl6/doc/trunk/design/apo/A12.pod>,
+L<http://svn.perl.org/perl6/doc/trunk/design/syn/S12.pod>
=cut
View
6 src/nci_test.c
@@ -1071,11 +1071,9 @@ main(void)
=back
-=head1 SEE ALSO:
+=head1 SEE ALSO
- F<docs/pdds/pdd16_native_call.pod>
- F<config/gen/makefiles/root.in>
- F<t/pmc/nci.t>
+F<docs/pdds/draft/pdd16_native_call.pod>, F<config/gen/makefiles/root.in>, F<t/pmc/nci.t>
=cut
View
1  src/packfile/api.c
@@ -1017,6 +1017,7 @@ Validates a C<PackFile_Header>, ensuring that the magic number is valid and
that Parrot can read this bytecode version.
Raises an exception if the header doesn't validate.
+
=cut
*/
View
6 src/pmc.c
@@ -1171,10 +1171,8 @@ Parrot_pmc_type_does(PARROT_INTERP, ARGIN(const STRING *role), INTVAL type)
=head1 SEE ALSO
-F<include/parrot/vtable.h>.
-
-C<5.1.0.14.2.20011008152120.02158148@pop.sidhe.org>
-(http://www.nntp.perl.org/group/perl.perl6.internals/5516).
+F<include/parrot/pmc.h>, F<include/parrot/vtable.h>,
+L<http://www.nntp.perl.org/group/perl.perl6.internals/2001/10/msg5516.html>
=cut
View
11 src/pointer_array.c
@@ -152,6 +152,17 @@ Parrot_pa_is_owned(PARROT_INTERP, ARGIN(Parrot_Pointer_Array *self),
return 0;
}
+/*
+
+=back
+
+=head1 SEE ALSO
+
+F<include/parrot/pointer_array.h>
+
+=cut
+
+*/
/*
* Local variables:
View
7 src/scheduler.c
@@ -999,7 +999,6 @@ opcode_t* to allow for changing the code flow.
=over 4
-
=item C<opcode_t * Parrot_cx_schedule_sleep(PARROT_INTERP, FLOATVAL time,
opcode_t *next)>
@@ -1108,8 +1107,6 @@ scheduler_process_wait_list(PARROT_INTERP, ARGMOD(PMC *scheduler))
/*
-=over 4
-
=item C<static void scheduler_process_messages(PARROT_INTERP, PMC *scheduler)>
Scheduler maintenance, scan the list of messages sent from other schedulers and
@@ -1158,6 +1155,10 @@ scheduler_process_messages(PARROT_INTERP, ARGMOD(PMC *scheduler))
=back
+=head1 SEE ALSO
+
+F<include/parrot/scheduler.h>
+
=cut
*/
View
2  src/spf_render.c
@@ -948,7 +948,7 @@ Parrot_sprintf_format(PARROT_INTERP, ARGIN(const STRING *pat), ARGMOD(SPRINTF_OB
=head1 SEE ALSO
-F<src/misc.h>, F<src/misc.c>, F<src/spf_vtable.c>.
+F<include/parrot/misc.h>, F<src/misc.c>, F<src/spf_vtable.c>
=cut
View
2  src/spf_vtable.c
@@ -628,7 +628,7 @@ SPRINTF_OBJ pmc_core = {
=head1 SEE ALSO
-F<src/misc.h>, F<src/misc.c>, F<src/spf_render.c>.
+F<include/parrot/misc.h>, F<src/misc.c>, F<src/spf_render.c>
=head1 HISTORY
View
12 src/thread.c
@@ -1655,6 +1655,18 @@ Parrot_shared_gc_unblock(SHIM_INTERP)
}
/*
+
+=back
+
+=head1 SEE ALSO
+
+F<include/parrot/thread.h>
+
+=cut
+
+*/
+
+/*
* Local variables:
* c-file-style: "parrot"
* End:
View
8 src/utils.c
@@ -7,8 +7,6 @@ src/utils.c - Some utility functions
=head1 DESCRIPTION
-Prototypes are in F<src/misc.h>.
-
Opcode helper functions that don't really fit elsewhere.
=head2 Functions
@@ -761,6 +759,12 @@ Parrot_util_quicksort(PARROT_INTERP, ARGMOD(void **data), UINTVAL n,
=back
+=head1 SEE ALSO
+
+F<include/parrot/misc.h>
+
+=cut
+
*/
View
12 src/vtables.c
@@ -244,6 +244,18 @@ Parrot_vtbl_initialize_core_vtables(PARROT_INTERP)
}
/*
+
+=back
+
+=head1 SEE ALSO
+
+F<include/parrot/vtables.h>
+
+=cut
+
+*/
+
+/*
* Local variables:
* c-file-style: "parrot"
* End:

0 comments on commit 4b296a2

Please sign in to comment.
Something went wrong with that request. Please try again.