Skip to content

Commit

Permalink
Correct POD syntax errors in POD embedded in .c, .pmc, .pir, etc files.
Browse files Browse the repository at this point in the history
  • Loading branch information
jkeenan committed Mar 16, 2014
1 parent 9b8c1dc commit 99d5781
Show file tree
Hide file tree
Showing 21 changed files with 36 additions and 3 deletions.
1 change: 1 addition & 0 deletions frontend/parrot/main.c
Expand Up @@ -396,6 +396,7 @@ is_all_digits(ARGIN(const char *s))
}

/*
=item C<static int is_float(const char *s)>
Tests all characters in a string are decimal digits or dot.
Expand Down
1 change: 1 addition & 0 deletions frontend/parrot2/main.c
Expand Up @@ -309,6 +309,7 @@ is_all_digits(ARGIN(const char *s))
}

/*
=item C<static int is_float(const char *s)>
Tests all characters in a string are decimal digits or dot.
Expand Down
4 changes: 1 addition & 3 deletions lib/Parrot/Pmc2c/PCCMETHOD.pm
Expand Up @@ -72,9 +72,7 @@ use constant REGNO_NUM => 1;
use constant REGNO_STR => 2;
use constant REGNO_PMC => 3;

=head3
regtype to argtype conversion hash
=head3 regtype to argtype conversion hash
=cut

Expand Down
1 change: 1 addition & 0 deletions runtime/parrot/library/Digest/sha256.pir
Expand Up @@ -90,6 +90,7 @@ consumption which should be resolved soon.
$P0 = newclass ['Digest';'SHA256']
$P0.'add_attribute'('context')
.end

=head2 C<sha256sum( str )>

Pass in a string, returns an Integer array with the resulting SHA256, and
Expand Down
1 change: 1 addition & 0 deletions runtime/parrot/library/TclLibrary.pir
Expand Up @@ -242,6 +242,7 @@ standard_names_e:
#
#static SV *
#SvFromTclObj(pTHX_ Tcl_Obj *objPtr)

=item pmc _pmc_from_tclobj(pmc interp, pmc tclobj)

This is a (static) function that will convert Tcl object to pmc
Expand Down
2 changes: 2 additions & 0 deletions src/gc/gc_gms.c
Expand Up @@ -1420,6 +1420,7 @@ gc_gms_get_gc_info(PARROT_INTERP, Interpinfo_enum which)


/*
=item C<static void gc_gms_finalize(PARROT_INTERP)>
Finalize GC subsystem.
Expand Down Expand Up @@ -2046,6 +2047,7 @@ gc_gms_pmc_needs_early_collection(PARROT_INTERP, SHIM(PMC *pmc))
}

/*
=item C<static void gc_gms_write_barrier(PARROT_INTERP, PMC *pmc)>
WriteBarrier for PMC. Add to root_objects list for mandatory next collecting.
Expand Down
1 change: 1 addition & 0 deletions src/gc/gc_ms.c
Expand Up @@ -1913,6 +1913,7 @@ gc_ms_total_sized_buffers(ARGIN(const Memory_Pools *mem_pools))
}

/*
=item C<static void gc_ms_iterate_live_strings(PARROT_INTERP,
string_iterator_callback callback, void *data)>
Expand Down
4 changes: 4 additions & 0 deletions src/gc/string_gc.c
Expand Up @@ -434,6 +434,7 @@ Parrot_gc_str_reallocate_string_storage(PARROT_INTERP,
}

/*
=item C<void Parrot_gc_str_compact_pool(PARROT_INTERP, String_GC *gc)>
Compact string pool.
Expand Down Expand Up @@ -494,6 +495,7 @@ Parrot_gc_str_free_buffer_storage(SHIM_INTERP,
}

/*
=item C<static Variable_Size_Pool * new_memory_pool(size_t min_block, compact_f
compact)>
Expand Down Expand Up @@ -720,6 +722,7 @@ buffer_location(PARROT_INTERP, ARGIN(const Parrot_Buffer *b))
=item C<static void debug_print_buf(PARROT_INTERP, const Parrot_Buffer *b)>
Prints a debug statement with information about the given PObj C<b>.
=cut
*/
Expand Down Expand Up @@ -801,6 +804,7 @@ compact_pool(PARROT_INTERP,
}

/*
=item C<static void move_buffer_callback(PARROT_INTERP, Parrot_Buffer *b, void
*data)>
Expand Down
1 change: 1 addition & 0 deletions src/ops/experimental.ops
Expand Up @@ -8,6 +8,7 @@ BEGIN_OPS_PREAMBLE
#include "pmc/pmc_task.h"

END_OPS_PREAMBLE

=head1 NAME

experimental.ops - Experimental Opcodes
Expand Down
1 change: 1 addition & 0 deletions src/pmc/arrayiterator.pmc
Expand Up @@ -450,6 +450,7 @@ the next one.
}

/*

=item C<PMC *get_pmc_keyed(PMC *key)>

Returns the element for C<*key>.
Expand Down
1 change: 1 addition & 0 deletions src/pmc/iterator.pmc
Expand Up @@ -135,6 +135,7 @@ Defaults iteration mode to iterate from start.
}

/*

=item C<PMC *get_pmc_keyed(PMC *key)>

Returns the element for C<*key>.
Expand Down
1 change: 1 addition & 0 deletions src/pmc/key.pmc
Expand Up @@ -378,6 +378,7 @@ Called after the Key has been thawed: convert last PMC_NULL key to NULL.
}

/*

=item C<set_register(reg_no, type)>

Set key to hold particular register.
Expand Down
1 change: 1 addition & 0 deletions src/pmc/os.pmc
Expand Up @@ -332,6 +332,7 @@ Reads entries from a directory.
}

/*

=item C<rename(STRING *oldpath, STRING *newpath)>

This method is a wrapper for rename(2). On error a SystemError exception is
Expand Down
3 changes: 3 additions & 0 deletions src/pmc/packfilebytecodesegment.pmc
Expand Up @@ -128,6 +128,7 @@ Return a pointer to a PackFile_ByteCode* built from this PMC's data.
}

/*

=item C<void set_pointer()>

Initialize PackfileBytecodeSegment from PackFile_Bytecode*
Expand Down Expand Up @@ -198,6 +199,7 @@ an op and the remaining PMCs being Integers.
}

/*

=item C<PMC* main_sub()>

Return :main Sub for this segment.
Expand All @@ -216,6 +218,7 @@ Return :main Sub for this segment.
}

/*

=item C<PMC* opmap()>

Return PackfileOpMap for this BytecodeSegment.
Expand Down
1 change: 1 addition & 0 deletions src/pmc/packfileconstanttable.pmc
Expand Up @@ -122,6 +122,7 @@ Set pointer to underlying PackFile_ConstTable
/*

=item C<void *get_pointer()>

=cut

*/
Expand Down
2 changes: 2 additions & 0 deletions src/pmc/packfileopmap.pmc
Expand Up @@ -142,6 +142,7 @@ already in the map, a new map will be created.


/*

=item C<get_pmc_keyed_str()>

Get Op PMC by name.
Expand Down Expand Up @@ -290,6 +291,7 @@ Ensure that an op library is loaded and accessible to this OpMap.


/*

=item C<get_pointer>

Construct PackFile_ByteCode_OpMapping.
Expand Down
8 changes: 8 additions & 0 deletions src/pmc/pmclist.pmc
Expand Up @@ -62,6 +62,7 @@ pmclass PMCList auto_attrs {
ATTR INTVAL size;

/*

=item C<void init()>

Initializes the list.
Expand All @@ -80,6 +81,7 @@ Initializes the list.
}

/*

=item C<void destroy()>

Free all the list cells.
Expand All @@ -103,6 +105,7 @@ Free all the list cells.
}

/*

=item C<INTVAL get_integer()>

Returns the size of the list.
Expand All @@ -124,6 +127,7 @@ Returns the size of the list.
}

/*

=item C<PMC *shift_pmc()>

Removes and returns an item from the start of the array.
Expand Down Expand Up @@ -173,6 +177,7 @@ Removes and returns an item from the start of the array.
}

/*

=item C<void push_pmc(PMC *value)>

Extends the array by adding an element of value C<*value> to the end of
Expand Down Expand Up @@ -212,6 +217,7 @@ the array.
}

/*

=item C<PMC *pop_pmc()>

Removes and returns the last element in the array.
Expand Down Expand Up @@ -409,6 +415,7 @@ Used to unarchive the array.
}

/*

=item C<void mark()>

Mark the stuff.
Expand Down Expand Up @@ -478,6 +485,7 @@ Method forms to add a PMC to the beginning or end of the array.
}

/*

=item METHOD insert_by_number(PMC* value)

Inserts an item into an ordered list by it's number value.
Expand Down
1 change: 1 addition & 0 deletions src/pmc/stringbuilder.pmc
Expand Up @@ -444,6 +444,7 @@ key receives the value of the hash element.
}

/*

=item C<INTVAL get_string_length()>

Returns length of currently built string.
Expand Down
1 change: 1 addition & 0 deletions src/runcore/subprof.c
Expand Up @@ -328,6 +328,7 @@ Return a pointer to the first line annotation of the sub and the number
of line annotations for this sub.
The C<spdata> argument is currently unused.
=cut
*/
Expand Down
2 changes: 2 additions & 0 deletions src/scheduler.c
Expand Up @@ -324,6 +324,7 @@ Parrot_cx_check_quantum(PARROT_INTERP, ARGIN(PMC *scheduler))
}

/*
=item C<PMC* Parrot_cx_stop_task(PARROT_INTERP, opcode_t *next)>
Stop the current task and pack it up into a PMC what can be used to resume later.
Expand Down Expand Up @@ -358,6 +359,7 @@ Parrot_cx_stop_task(PARROT_INTERP, ARGIN(opcode_t *next))
}

/*
=item C<opcode_t* Parrot_cx_preempt_task(PARROT_INTERP, PMC *scheduler, opcode_t
*next)>
Expand Down
1 change: 1 addition & 0 deletions src/utils.c
Expand Up @@ -698,6 +698,7 @@ COMPARE(PARROT_INTERP, ARGIN(void *_a), ARGIN(void *_b),
Perform a quicksort on a PMC array.
cmp_signature is PCC signature for C<cmp>. E.g. C<II->I> for FIA.
=cut
*/
Expand Down

0 comments on commit 99d5781

Please sign in to comment.